diff --git a/.clinerules/mobile-rule.md b/.clinerules/mobile-rule.md new file mode 100644 index 0000000..6055bbc --- /dev/null +++ b/.clinerules/mobile-rule.md @@ -0,0 +1,2031 @@ +# UniApp 移动端项目开发规范 + +## 项目概述 + +本项目是一个基于 UniApp 框架开发的跨平台移动应用，支持 H5、小程序、App 多端运行，采用 Vue 3 + Composition API 开发模式。 + +## 技术栈 + +- **UniApp**: 跨平台应用开发框架 +- **Vue 3**: 渐进式 JavaScript 框架 +- **JavaScript**: 主要开发语言（非 TypeScript） +- **Composition API**: Vue 3 组合式 API 开发模式 +- **Pinia**: 状态管理库 +- **easycom**: UniApp 组件自动引入机制 +- **luch-request**: 基于 Promise 的 HTTP 请求库 +- **mp-html**: 富文本渲染组件 +- **uni.scss**: 全局样式变量 + +## 开发规范 + +### 1. 项目结构 + +``` +resources/mobile/ +├── pages/ # 页面目录 +│ ├── index/ # 首页模块 +│ │ └── index.vue # 首页 +│ ├── auth/ # 认证相关页面 +│ │ ├── login/ # 登录页 +│ │ ├── register/ # 注册页 +│ │ └── forgot-password/ # 忘记密码 +│ ├── user/ # 用户中心页面 +│ │ ├── profile/ # 个人资料 +│ │ ├── settings/ # 设置 +│ │ └── address/ # 地址管理 +│ ├── shop/ # 商城模块 +│ │ ├── product/ # 商品相关 +│ │ ├── cart/ # 购物车 +│ │ └── order/ # 订单相关 +│ └── common/ # 公共页面 +│ ├── webview/ # Webview 页面 +│ └── error/ # 错误页面 +├── components/ # 公共组件目录 +│ ├── sc-button/ # 自定义按钮组件 +│ ├── sc-card/ # 自定义卡片组件 +│ ├── sc-list/ # 自定义列表组件 +│ └── sc-upload/ # 上传组件 +├── static/ # 静态资源 +│ ├── images/ # 图片资源 +│ ├── icons/ # 图标资源 +│ └── fonts/ # 字体资源 +├── api/ # API 接口层 +│ ├── index.js # API 入口 +│ ├── request.js # 请求封装 +│ ├── auth.js # 认证相关接口 +│ ├── user.js # 用户相关接口 +│ └── shop.js # 商城相关接口 +├── stores/ # 状态管理 +│ ├── index.js # Store 入口 +│ ├── user.js # 用户状态 +│ ├── cart.js # 购物车状态 +│ └── config.js # 配置状态 +├── utils/ # 工具函数 +│ ├── index.js # 工具函数入口 +│ ├── validate.js # 表单验证 +│ ├── format.js # 格式化工具 +│ └── storage.js # 存储工具 +├── config/ # 配置文件 +│ ├── index.js # 主配置 +│ ├── env.js # 环境配置 +│ └── const.js # 常量配置 +├── styles/ # 样式文件 +│ ├── common.scss # 公共样式 +│ ├── variables.scss # 样式变量 +│ └── mixins.scss # 样式混入 +├── App.vue # 根组件 +├── main.js # 入口文件 +├── manifest.json # 应用配置 +├── pages.json # 页面路由配置 +├── uni.scss # 全局样式变量 +├── package.json # 依赖配置 +└── README.md # 项目说明 +``` + +### 2. 页面开发规范 + +#### 页面命名规范 + +- **目录命名**: 使用 kebab-case，如 `user-profile`, `product-list` +- **文件命名**: 使用 index.vue 作为入口文件 +- **路径格式**: `pages/{module}/{feature}/index.vue` + +#### scPages 页面框架组件 + +**重要提示**: 所有页面必须使用 `scPages` 组件作为页面框架，确保统一的页面布局和交互体验。 + +#### scPages 组件结构 + +```vue + + + + + +``` + +#### 使用 scPages 组件 + +```vue + + + + + +``` + +#### scPages 组件配置选项 + +| 属性 | 类型 | 默认值 | 说明 | +|------|------|--------|------| +| title | String | '' | 页面标题 | +| showNavbar | Boolean | true | 是否显示导航栏 | +| showBack | Boolean | true | 是否显示返回按钮 | +| navbarBgColor | String | '#fff' | 导航栏背景色 | +| navbarTextColor | String | '#333' | 导航栏文字颜色 | +| bgColor | String | '#f5f5f5' | 页面背景色 | + +#### 插槽 + +| 插槽名 | 说明 | +|--------|------| +| default | 页面内容 | +| navbar-right | 导航栏右侧内容 | +| footer | 底部操作栏 | + +#### 事件 + +| 事件名 | 说明 | 返回值 | +|--------|------|--------| +| back | 返回上一页 | - | +| scrollToUpper | 滚动到顶部 | - | +| scrollToLower | 滚动到底部 | - | + +#### 方法 + +| 方法名 | 说明 | 参数 | +|--------|------|------| +| scrollToTop | 滚动到指定位置 | top (默认: 0) | + +#### 页面结构模板 + +```vue + + + + + +``` + +#### 页面生命周期 + +```javascript + +``` + +### 3. 组件引入规范（easycom） + +**重要提示**: 项目使用 UniApp 的 easycom 组件自动引入机制，无需手动 import 和注册组件，直接在模板中使用即可。 + +#### easycom 配置 + +在 `pages.json` 中配置 easycom： + +```json +{ + "easycom": { + "autoscan": true, + "custom": { + "^sc-(.*)": "@/components/sc-$1/index.vue" + } + } +} +``` + +#### 组件使用 + +```vue + + + +``` + +#### 组件命名规范 + +- **目录命名**: 使用 PascalCase，如 `ScButton`, `ScCard` +- **文件命名**: 使用 index.vue 作为入口文件 +- **组件使用**: 在模板中使用 kebab-case，如 `` +- **前缀规范**: 自定义组件统一使用 `sc-` 前缀 + +#### 组件开发规范 + +#### 组件结构模板 + +```vue + + + + + +``` + +### 4. 路由开发规范 + +#### 页面路由配置 + +在 `pages.json` 中配置页面路由： + +```json +{ + "pages": [ + { + "path": "pages/index/index", + "style": { + "navigationBarTitleText": "首页", + "navigationStyle": "custom" + } + }, + { + "path": "pages/auth/login/index", + "style": { + "navigationBarTitleText": "登录", + "navigationStyle": "custom" + } + }, + { + "path": "pages/user/profile/index", + "style": { + "navigationBarTitleText": "个人中心", + "navigationStyle": "custom" + } + } + ], + "globalStyle": { + "navigationBarTextStyle": "black", + "navigationBarTitleText": "UniApp", + "navigationBarBackgroundColor": "#FFFFFF", + "backgroundColor": "#F5F5F5" + }, + "tabBar": { + "color": "#999999", + "selectedColor": "#007AFF", + "backgroundColor": "#FFFFFF", + "borderStyle": "black", + "list": [ + { + "pagePath": "pages/index/index", + "text": "首页", + "iconPath": "static/icons/home.png", + "selectedIconPath": "static/icons/home-active.png" + }, + { + "pagePath": "pages/shop/index/index", + "text": "商城", + "iconPath": "static/icons/shop.png", + "selectedIconPath": "static/icons/shop-active.png" + }, + { + "pagePath": "pages/user/profile/index", + "text": "我的", + "iconPath": "static/icons/user.png", + "selectedIconPath": "static/icons/user-active.png" + } + ] + } +} +``` + +#### 路由跳转 + +```javascript +// 保留当前页面，跳转到应用内的某个页面 +uni.navigateTo({ + url: '/pages/user/detail/index?id=123' +}) + +// 关闭当前页面，跳转到应用内的某个页面 +uni.redirectTo({ + url: '/pages/auth/login/index' +}) + +// 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 +uni.switchTab({ + url: '/pages/index/index' +}) + +// 关闭所有页面，打开到应用内的某个页面 +uni.reLaunch({ + url: '/pages/index/index' +}) + +// 返回上一页 +uni.navigateBack({ + delta: 1 +}) + +// 获取页面参数 +onLoad((options) => { + const { id, type } = options +}) +``` + +#### 页面传参 + +```javascript +// 传递参数 +uni.navigateTo({ + url: `/pages/product/detail/index?id=${productId}&type=1` +}) + +// 或者使用对象形式 +const params = { + id: productId, + type: 1, + name: '商品名称' +} +uni.navigateTo({ + url: `/pages/product/detail/index?data=${encodeURIComponent(JSON.stringify(params))}` +}) + +// 接收参数 +onLoad((options) => { + if (options.data) { + const data = JSON.parse(decodeURIComponent(options.data)) + console.log(data) + } +}) +``` + +### 5. API 接口开发规范（luch-request） + +#### API 文件组织 + +每个业务模块对应一个 API 文件，统一放在 `api/` 目录下。 + +```javascript +// api/auth.js +import http from './http' + +export default { + // 登录 + login: (data) => { + return http.post('/api/auth/login', data) + }, + + // 注册 + register: (data) => { + return http.post('/api/auth/register', data) + }, + + // 登出 + logout: () => { + return http.post('/api/auth/logout') + }, + + // 获取用户信息 + getUserInfo: () => { + return http.get('/api/auth/user') + }, + + // 刷新令牌 + refreshToken: (refreshToken) => { + return http.post('/api/auth/refresh', { refresh_token: refreshToken }) + } +} +``` + +#### luch-request 封装 + +```javascript +// api/http.js +import Request from 'luch-request' +import config from '@/config' +import { useUserStore } from '@/stores/user' + +const http = new Request({ + baseURL: config.apiBaseUrl, + timeout: 60000, + header: { + 'Content-Type': 'application/json' + } +}) + +// 请求拦截器 +http.interceptors.request.use((config) => { + // 添加 Token + const userStore = useUserStore() + if (userStore.token) { + config.header = { + ...config.header, + 'Authorization': `Bearer ${userStore.token}` + } + } + + // 添加时间戳防止缓存 + if (config.method === 'GET') { + config.params = { + ...config.params, + _t: Date.now() + } + } + + // 显示加载提示 + if (config.loading !== false) { + uni.showLoading({ + title: config.loadingText || '加载中...', + mask: true + }) + } + + return config +}, (error) => { + return Promise.reject(error) +}) + +// 响应拦截器 +http.interceptors.response.use((response) => { + // 隐藏加载提示 + uni.hideLoading() + + const { statusCode, data } = response + + // HTTP 状态码判断 + if (statusCode !== 200) { + handleError(statusCode) + return Promise.reject(response) + } + + // 业务状态码判断 + if (data.code !== 200) { + handleBusinessError(data) + return Promise.reject(data) + } + + return data +}, (error) => { + // 隐藏加载提示 + uni.hideLoading() + + // 网络错误处理 + if (error.errMsg) { + uni.showToast({ + title: error.errMsg || '网络错误', + icon: 'none' + }) + } + + return Promise.reject(error) +}) + +// 错误处理 +const handleError = (statusCode) => { + let message = '网络错误' + + switch (statusCode) { + case 401: + message = '未授权，请登录' + // 跳转到登录页 + uni.navigateTo({ + url: '/pages/auth/login/index' + }) + break + case 403: + message = '拒绝访问' + break + case 404: + message = '请求错误，未找到该资源' + break + case 500: + message = '服务器错误' + break + } + + uni.showToast({ + title: message, + icon: 'none' + }) +} + +const handleBusinessError = (data) => { + uni.showToast({ + title: data.message || '操作失败', + icon: 'none' + }) +} + +export default http +``` + +#### 使用示例 + +```javascript + +``` + +### 6. 状态管理规范 + +#### Pinia Store 定义 + +使用组合式 API 定义 Store。 + +```javascript +// stores/user.js +import { ref, computed } from 'vue' +import { defineStore } from 'pinia' + +export const useUserStore = defineStore('user', () => { + // State + const token = ref('') + const refreshToken = ref('') + const userInfo = ref(null) + + // Getters + const isLoggedIn = computed(() => !!token.value) + const userName = computed(() => userInfo.value?.name || '') + + // Actions + function setToken(newToken) { + token.value = newToken + uni.setStorageSync('token', newToken) + } + + function setUserInfo(info) { + userInfo.value = info + uni.setStorageSync('userInfo', info) + } + + function clearUserData() { + token.value = '' + refreshToken.value = '' + userInfo.value = null + uni.removeStorageSync('token') + uni.removeStorageSync('refreshToken') + uni.removeStorageSync('userInfo') + } + + // 从本地存储初始化 + function initFromStorage() { + const savedToken = uni.getStorageSync('token') + const savedUserInfo = uni.getStorageSync('userInfo') + if (savedToken) { + token.value = savedToken + } + if (savedUserInfo) { + userInfo.value = savedUserInfo + } + } + + return { + token, + refreshToken, + userInfo, + isLoggedIn, + userName, + setToken, + setUserInfo, + clearUserData, + initFromStorage + } +}) +``` + +#### Store 使用 + +```javascript + +``` + +### 7. 工具函数开发规范 + +#### 常用工具函数 + +```javascript +// utils/index.js + +// 深拷贝 +export const deepClone = (obj) => { + return JSON.parse(JSON.stringify(obj)) +} + +// 防抖 +export const debounce = (fn, delay = 300) => { + let timer = null + return function(...args) { + if (timer) clearTimeout(timer) + timer = setTimeout(() => { + fn.apply(this, args) + }, delay) + } +} + +// 节流 +export const throttle = (fn, delay = 300) => { + let lastTime = 0 + return function(...args) { + const now = Date.now() + if (now - lastTime >= delay) { + fn.apply(this, args) + lastTime = now + } + } +} + +// 格式化时间 +export const formatDate = (date, format = 'YYYY-MM-DD HH:mm:ss') => { + if (!date) return '' + + const d = new Date(date) + const year = d.getFullYear() + const month = String(d.getMonth() + 1).padStart(2, '0') + const day = String(d.getDate()).padStart(2, '0') + const hours = String(d.getHours()).padStart(2, '0') + const minutes = String(d.getMinutes()).padStart(2, '0') + const seconds = String(d.getSeconds()).padStart(2, '0') + + return format + .replace('YYYY', year) + .replace('MM', month) + .replace('DD', day) + .replace('HH', hours) + .replace('mm', minutes) + .replace('ss', seconds) +} + +// 格式化金额 +export const formatMoney = (amount, decimals = 2) => { + return Number(amount).toFixed(decimals) +} + +// 手机号脱敏 +export const maskPhone = (phone) => { + if (!phone) return '' + return phone.replace(/(\d{3})\d{4}(\d{4})/, '$1****$2') +} + +// 判断是否为空 +export const isEmpty = (value) => { + if (value === null || value === undefined) return true + if (typeof value === 'string') return value.trim() === '' + if (Array.isArray(value)) return value.length === 0 + if (typeof value === 'object') return Object.keys(value).length === 0 + return false +} +``` + +#### 表单验证工具 + +```javascript +// utils/validate.js + +// 手机号验证 +export const isPhone = (phone) => { + return /^1[3-9]\d{9}$/.test(phone) +} + +// 邮箱验证 +export const isEmail = (email) => { + return /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(email) +} + +// 身份证验证 +export const isIdCard = (idCard) => { + return /(^\d{15}$)|(^\d{18}$)|(^\d{17}(\d|X|x)$)/.test(idCard) +} + +// 密码强度验证 +export const checkPasswordStrength = (password) => { + let strength = 0 + if (password.length >= 8) strength++ + if (/[A-Z]/.test(password)) strength++ + if (/[a-z]/.test(password)) strength++ + if (/[0-9]/.test(password)) strength++ + if (/[^A-Za-z0-9]/.test(password)) strength++ + + return strength +} +``` + +### 8. 样式开发规范 + +#### 使用 uni.scss 变量 + +```scss +// uni.scss 已内置以下变量，可以直接使用 + +/* 颜色变量 */ +$uni-color-primary: #007aff; +$uni-color-success: #4cd964; +$uni-color-warning: #f0ad4e; +$uni-color-error: #dd524d; + +/* 文字基本颜色 */ +$uni-text-color: #333; +$uni-text-color-grey: #999; +$uni-text-color-placeholder: #808080; +$uni-text-color-disable: #c0c0c0; + +/* 背景颜色 */ +$uni-bg-color: #ffffff; +$uni-bg-color-grey: #f8f8f8; +$uni-bg-color-hover: #f1f1f1; + +/* 边框颜色 */ +$uni-border-color: #c8c7cc; + +/* 尺寸变量 */ +$uni-spacing-row-sm: 5px; +$uni-spacing-row-base: 10px; +$uni-spacing-row-lg: 15px; + +$uni-spacing-col-sm: 5px; +$uni-spacing-col-base: 10px; +$uni-spacing-col-lg: 15px; + +/* 字体大小 */ +$uni-font-size-sm: 12px; +$uni-font-size-base: 14px; +$uni-font-size-lg: 16px; +$uni-font-size-title: 18px; + +/* 图片尺寸 */ +$uni-img-size-sm: 40px; +$uni-img-size-base: 52px; +$uni-img-size-lg: 80px; + +/* Border Radius */ +$uni-border-radius-sm: 4px; +$uni-border-radius-base: 6px; +$uni-border-radius-lg: 12px; +$uni-border-radius-circle: 50%; + +/* 阴影 */ +$uni-shadow-sm: 0 0 5px rgba(0, 0, 0, 0.1); +$uni-shadow-base: 0 1px 8px 1px rgba(0, 0, 0, 0.1); +$uni-shadow-lg: 0 4px 16px 1px rgba(0, 0, 0, 0.15); +``` + +#### 样式组织 + +```vue + +``` + +#### 响应式单位 + +```scss +// 使用 rpx 单位实现屏幕适配 +.container { + width: 750rpx; // 等于屏幕宽度 + padding: 30rpx; // 根据屏幕宽度自动缩放 + font-size: 28rpx; +} + +// 混合使用 px 和 rpx +.button { + font-size: 28rpx; + border-radius: 8px; // 边框圆角建议使用 px + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1); // 阴影建议使用 px +} +``` + +### 9. 本地存储规范 + +#### 使用 uni.storage + +```javascript +// 存储数据 +uni.setStorageSync('token', 'xxx') +uni.setStorageSync('userInfo', { name: '张三' }) + +// 异步存储 +uni.setStorage({ + key: 'token', + data: 'xxx', + success: () => { + console.log('存储成功') + } +}) + +// 读取数据 +const token = uni.getStorageSync('token') +const userInfo = uni.getStorageSync('userInfo') + +// 异步读取 +uni.getStorage({ + key: 'token', + success: (res) => { + console.log(res.data) + } +}) + +// 删除数据 +uni.removeStorageSync('token') + +// 异步删除 +uni.removeStorage({ + key: 'token', + success: () => { + console.log('删除成功') + } +}) + +// 清空所有数据 +uni.clearStorageSync() + +// 获取所有存储信息 +uni.getStorageInfo({ + success: (res) => { + console.log(res.keys) + console.log(res.currentSize) + console.log(res.limitSize) + } +}) +``` + +#### 封装存储工具 + +```javascript +// utils/storage.js + +const STORAGE_PREFIX = 'app_' + +export default { + // 设置 + set(key, value) { + try { + uni.setStorageSync(STORAGE_PREFIX + key, JSON.stringify(value)) + return true + } catch (e) { + console.error('存储失败', e) + return false + } + }, + + // 获取 + get(key, defaultValue = null) { + try { + const value = uni.getStorageSync(STORAGE_PREFIX + key) + if (value) { + return JSON.parse(value) + } + return defaultValue + } catch (e) { + console.error('读取失败', e) + return defaultValue + } + }, + + // 删除 + remove(key) { + try { + uni.removeStorageSync(STORAGE_PREFIX + key) + return true + } catch (e) { + console.error('删除失败', e) + return false + } + }, + + // 清空 + clear() { + try { + uni.clearStorageSync() + return true + } catch (e) { + console.error('清空失败', e) + return false + } + } +} +``` + +### 10. 富文本渲染规范（mp-html） + +#### mp-html 简介 + +mp-html 是一个强大的富文本渲染组件，支持 HTML 标签和样式，适用于在 UniApp 中渲染富文本内容。 + +#### 安装依赖 + +```bash +npm install mp-html +``` + +#### 基本使用 + +```vue + + + +``` + +#### 高级配置 + +```vue + + + + + +``` + +#### 使用场景 + +1. **文章详情页**: 渲染后端返回的富文本内容 +2. **商品描述**: 展示商品的详细描述 +3. **公告通知**: 显示富文本格式的公告 +4. **帮助文档**: 渲染帮助文档内容 + +#### 注意事项 + +1. **安全性**: 后端返回的 HTML 内容应经过过滤和消毒，防止 XSS 攻击 +2. **性能**: 避免在列表中大量使用 mp-html，会影响性能 +3. **样式**: 建议使用 `tag-style` 配置标签样式，而不是全局样式 +4. **图片**: 处理图片点击事件，提供图片预览功能 +5. **链接**: 处理链接点击事件，跳转到 webview 页面 + +### 11. 图片资源规范 + +#### 图片路径引用 + +```vue + + + +``` + +#### 图片模式 + +```vue + + + + + + + + + + + + + + +``` + +### 11. 上传文件规范 + +#### 使用 uni.chooseImage + +```javascript +// 选择图片 +const chooseImage = () => { + uni.chooseImage({ + count: 9, // 最多选择的图片数量 + sizeType: ['original', 'compressed'], // 可以指定是原图还是压缩图 + sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机 + success: (res) => { + const tempFilePaths = res.tempFilePaths + console.log(tempFilePaths) + // 上传图片 + uploadImages(tempFilePaths) + } + }) +} + +// 上传图片 +const uploadImages = (files) => { + files.forEach((filePath, index) => { + uni.uploadFile({ + url: 'https://example.com/api/upload', + filePath, + name: 'file', + formData: { + 'type': 'avatar' + }, + header: { + 'Authorization': `Bearer ${userStore.token}` + }, + success: (uploadFileRes) => { + const data = JSON.parse(uploadFileRes.data) + console.log('上传成功', data) + }, + fail: (error) => { + console.error('上传失败', error) + } + }) + }) +} +``` + +### 12. 常用 API 规范 + +#### 网络请求 + +```javascript +// GET 请求 +uni.request({ + url: 'https://example.com/api/data', + method: 'GET', + data: { + page: 1, + pageSize: 10 + }, + header: { + 'Content-Type': 'application/json' + }, + success: (res) => { + console.log(res.data) + } +}) + +// POST 请求 +uni.request({ + url: 'https://example.com/api/save', + method: 'POST', + data: { + name: '张三', + age: 18 + }, + header: { + 'Content-Type': 'application/json' + }, + success: (res) => { + console.log(res.data) + } +}) +``` + +#### 提示框 + +```javascript +// 显示提示框 +uni.showToast({ + title: '操作成功', + icon: 'success', + duration: 2000 +}) + +// 显示加载中 +uni.showLoading({ + title: '加载中...', + mask: true +}) + +// 隐藏加载中 +uni.hideLoading() + +// 显示确认对话框 +uni.showModal({ + title: '提示', + content: '确定要删除吗？', + success: (res) => { + if (res.confirm) { + console.log('用户点击确定') + } else if (res.cancel) { + console.log('用户点击取消') + } + } +}) + +// 显示操作菜单 +uni.showActionSheet({ + itemList: ['拍照', '从相册选择'], + success: (res) => { + console.log(res.tapIndex) + } +}) +``` + +#### 导航栏 + +```javascript +// 设置导航栏标题 +uni.setNavigationBarTitle({ + title: '新的标题' +}) + +// 设置导航栏颜色 +uni.setNavigationBarColor({ + frontColor: '#ffffff', + backgroundColor: '#000000' +}) + +// 显示导航栏加载动画 +uni.showNavigationBarLoading() + +// 隐藏导航栏加载动画 +uni.hideNavigationBarLoading() +``` + +#### 下拉刷新 + +```javascript +// 开启下拉刷新 +uni.startPullDownRefresh() + +// 停止下拉刷新 +uni.stopPullDownRefresh() + +// 在页面中配置下拉刷新 +// pages.json +{ + "path": "pages/index/index", + "style": { + "enablePullDownRefresh": true, + "backgroundColor": "#f5f5f5", + "backgroundTextStyle": "dark" + } +} + +// 监听下拉刷新 +onPullDownRefresh(() => { + console.log('下拉刷新') + // 执行刷新逻辑 + setTimeout(() => { + uni.stopPullDownRefresh() + }, 1000) +}) +``` + +### 13. 跨平台兼容性处理 + +#### 条件编译 + +```javascript +// #ifdef H5 +console.log('只在 H5 平台执行') +// #endif + +// #ifdef MP-WEIXIN +console.log('只在微信小程序执行') +// #endif + +// #ifdef APP-PLUS +console.log('只在 App 平台执行') +// #endif + +// #ifndef H5 +console.log('除了 H5 平台都执行') +// #endif +``` + +```vue + + + +``` + +### 14. 性能优化建议 + +#### 列表性能优化 + +```vue + +``` + +#### 图片懒加载 + +```vue + +``` + +#### 避免频繁更新 + +```javascript +// 使用防抖避免频繁触发 +import { debounce } from '@/utils' + +const handleSearch = debounce((keyword) => { + console.log('搜索:', keyword) +}, 300) +``` + +### 15. 常用命令 + +```bash +# 安装依赖 +npm install + +# 安装 luch-request（HTTP 请求库） +npm install luch-request + +# 安装 mp-html（富文本渲染组件） +npm install mp-html + +# 安装 pinia（状态管理库） +npm install pinia + +# 开发环境运行 H5 +npm run dev:h5 + +# 开发环境运行微信小程序 +npm run dev:mp-weixin + +# 开发环境运行 App +npm run dev:app + +# 生产环境构建 H5 +npm run build:h5 + +# 生产环境构建微信小程序 +npm run build:mp-weixin + +# 生产环境构建 App +npm run build:app +``` + +### 16. 注意事项 + +1. **使用 Composition API**: 新代码统一使用 ` + + diff --git a/resources/mobile/components/sc-pages/README.md b/resources/mobile/components/sc-pages/README.md new file mode 100644 index 0000000..a2fc68f --- /dev/null +++ b/resources/mobile/components/sc-pages/README.md @@ -0,0 +1,315 @@ +# sc-pages 组件 + +功能完善的移动端页面框架组件，基于 Vue 3 + Composition API 开发，集成了 uni-nav-bar 和 sc-tabbar 组件。 + +## 功能特性 + +- ✅ 顶部导航栏（基于 uni-nav-bar） + - 支持自定义标题、左右按钮 + - 支持沉浸式状态栏 + - 支持自定义主题色 + - 支持自定义插槽 +- ✅ 中间内容区域 + - Flex 布局，占满剩余高度 + - 滚动条只在内容区域显示 + - 支持下拉刷新 + - 支持滚动事件监听 +- ✅ 底部 TabBar（基于 sc-tabbar） + - 支持图标、徽标、红点 + - 可在不同页面移除 + - 支持主题自定义 +- ✅ 响应式布局 + - 自动适配不同屏幕 + - 支持底部安全区适配 + +## 安装使用 + +由于项目已配置 easycom 组件自动引入，无需手动 import，直接在模板中使用即可。 + +### 基础用法 + +```vue + + + +``` + +## Props 属性 + +### 页面基础配置 + +| 属性名 | 类型 | 默认值 | 说明 | +|--------|------|--------|------| +| title | String | '' | 页面标题 | +| pageStyle | String, Object | '' | 页面样式 | +| fixed | Boolean | true | 是否固定定位 | + +### 导航栏配置 + +| 属性名 | 类型 | 默认值 | 说明 | +|--------|------|--------|------| +| showNavbar | Boolean | true | 是否显示导航栏 | +| showBack | Boolean | true | 是否显示返回按钮 | +| navbarBgColor | String | '#FFFFFF' | 导航栏背景色 | +| navbarColor | String | '#000000' | 导航栏文字颜色 | +| statusBar | Boolean | true | 是否沉浸式状态栏 | +| shadow | Boolean | false | 是否显示阴影 | +| border | Boolean | true | 是否显示边框 | +| leftIcon | String | 'left' | 左侧图标 | +| rightIcon | String | '' | 右侧图标 | +| titleWidth | String | '' | 标题宽度 | +| dark | Boolean | false | 暗黑模式 | + +### 内容区域配置 + +| 属性名 | 类型 | 默认值 | 说明 | +|--------|------|--------|------| +| scrollTop | Number | 0 | 滚动条位置 | +| scrollWithAnimation | Boolean | false | 是否使用滚动动画 | +| showScrollbar | Boolean | false | 是否显示滚动条 | +| refresherEnabled | Boolean | false | 是否开启下拉刷新 | +| refresherTriggered | Boolean | false | 下拉刷新状态 | +| refresherBackground | String | '#FFFFFF' | 下拉刷新背景色 | + +### TabBar 配置 + +| 属性名 | 类型 | 默认值 | 说明 | +|--------|------|--------|------| +| showTabbar | Boolean | false | 是否显示 TabBar | +| tabbarList | Array | [] | TabBar 列表 | +| currentTab | Number | 0 | 当前选中的 Tab | +| safeAreaInsetBottom | Boolean | true | 是否开启底部安全区适配 | +| tabbarActiveColor | String | '#007AFF' | TabBar 选中颜色 | +| tabbarInactiveColor | String | '#999999' | TabBar 未选中颜色 | +| tabbarBgColor | String | '#FFFFFF' | TabBar 背景颜色 | +| tabbarBorderColor | String | '#E5E5E5' | TabBar 边框颜色 | + +## Events 事件 + +### 导航栏事件 + +| 事件名 | 参数 | 说明 | +|--------|------|------| +| back | - | 返回按钮点击时触发 | +| left-click | - | 左侧按钮点击时触发 | +| right-click | - | 右侧按钮点击时触发 | + +### 内容区域事件 + +| 事件名 | 参数 | 说明 | +|--------|------|------| +| scroll | e | 滚动时触发 | +| scrolltoupper | e | 滚动到顶部时触发 | +| scrolltolower | e | 滚动到底部时触发 | +| refresherrefresh | e | 下拉刷新时触发 | +| refresherrestore | e | 下拉刷新结束时触发 | + +### TabBar 事件 + +| 事件名 | 参数 | 说明 | +|--------|------|------| +| tabbar-change | (index, item) | Tab 切换时触发 | +| tabbar-click | (index, item) | Tab 点击时触发 | + +## Slots 插槽 + +| 插槽名 | 说明 | 参数 | +|--------|------|------| +| default | 默认内容（页面内容） | - | +| navbar-left | 自定义导航栏左侧内容 | - | +| navbar-title | 自定义导航栏标题 | - | +| navbar-right | 自定义导航栏右侧内容 | - | +| tabbar-icon | 自定义 TabBar 图标 | { item, index, active } | + +## 使用示例 + +### 1. 基础用法（带导航栏） + +```vue + +``` + +### 2. 完整页面（带 TabBar） + +```vue + + + +``` + +### 3. 下拉刷新 + +```vue + + + +``` + +### 4. 自定义导航栏 + +```vue + + + +``` + +### 5. 无导航栏 + +```vue + +``` + +### 6. 无 TabBar + +```vue + +``` + +## 布局说明 + +组件采用 Flex 布局结构： + +``` +sc-pages (flex-direction: column, height: 100vh) +├── uni-nav-bar (固定高度) +├── scroll-view (flex: 1, 占满剩余高度) +│ └── view (内容区域) +└── sc-tabbar (可选，固定高度) +``` + +- 整体容器使用 `flex-direction: column` 垂直布局 +- 中间内容区域使用 `flex: 1` 占据剩余全部高度 +- 滚动条只在 scroll-view 区域显示 +- 导航栏和 TabBar 根据配置动态显示/隐藏 + +## 注意事项 + +1. **TabBar 配置**: `show-tabbar` 为 `false` 时，TabBar 不会渲染，可在不同页面灵活控制 +2. **导航栏配置**: `show-navbar` 为 `false` 时，导航栏不会渲染，适合全屏页面 +3. **下拉刷新**: 使用 `refresher-triggered` 控制刷新状态，刷新完成后需将其设为 `false` +4. **滚动事件**: 监听 `scrolltolower` 事件实现上拉加载更多 +5. **安全区适配**: iPhone X 及以上设备会自动适配底部安全区 + +## 完整示例 + +查看 `resources/mobile/pages/example/pages/` 目录下的示例页面： + +- `example1.vue` - 基础用法 +- `example2.vue` - 完整页面（带 TabBar） +- `example3.vue` - 下拉刷新 +- `example4.vue` - 自定义导航栏 +- `example5.vue` - 无导航栏 + +## License + +MIT diff --git a/resources/mobile/components/sc-pages/index.vue b/resources/mobile/components/sc-pages/index.vue new file mode 100644 index 0000000..cf88619 --- /dev/null +++ b/resources/mobile/components/sc-pages/index.vue @@ -0,0 +1,393 @@ + + + + + diff --git a/resources/mobile/components/sc-tabbar/README.md b/resources/mobile/components/sc-tabbar/README.md new file mode 100644 index 0000000..a24660a --- /dev/null +++ b/resources/mobile/components/sc-tabbar/README.md @@ -0,0 +1,276 @@ +# sc-tabbar 组件 + +功能完善的移动端底部导航栏组件，基于 Vue 3 + Composition API 开发。 + +## 功能特性 + +- ✅ 支持自定义图标（iconfont） +- ✅ 支持徽标显示（badge） +- ✅ 支持红点显示（dot） +- ✅ 支持自定义主题色 +- ✅ 支持底部安全区适配 +- ✅ 支持 v-model 双向绑定 +- ✅ 支持固定定位 +- ✅ 支持自定义图标插槽 +- ✅ 流畅的过渡动画 + +## 安装使用 + +由于项目已配置 easycom 组件自动引入，无需手动 import，直接在模板中使用即可。 + +```vue + + + +``` + +## Props 属性 + +| 属性名 | 类型 | 默认值 | 说明 | +|--------|------|--------|------| +| list | Array | [] | tab 列表数据 | +| modelValue | Number | 0 | 当前选中的索引（v-model 绑定） | +| fixed | Boolean | true | 是否固定在底部 | +| safeAreaInsetBottom | Boolean | true | 是否开启底部安全区适配 | +| activeColor | String | '#007AFF' | 选中颜色 | +| inactiveColor | String | '#999999' | 未选中颜色 | +| bgColor | String | '#FFFFFF' | 背景颜色 | +| borderColor | String | '#E5E5E5' | 边框颜色 | +| customClass | String | '' | 自定义类名 | + +## list 数据结构 + +```javascript +{ + text: '首页', // tab 文本 + iconPath: 'home', // 未选中图标（iconfont 类名） + selectedIconPath: 'home-fill', // 选中图标（iconfont 类名） + badge: '5', // 徽标数字（可选） + dot: true, // 是否显示红点（可选） + pagePath: '/pages/index/index' // 跳转路径（可选） +} +``` + +## Events 事件 + +| 事件名 | 参数 | 说明 | +|--------|------|------| +| update:modelValue | index | 当前选中索引更新时触发 | +| change | (index, item) | tab 切换时触发 | +| click | (index, item) | 点击 tab 时触发 | + +## Slots 插槽 + +| 插槽名 | 说明 | 参数 | +|--------|------|------| +| icon | 自定义图标内容 | { item, index, active } | + +## 使用示例 + +### 基础用法 + +```vue + + + +``` + +### 显示徽标 + +```vue + + + +``` + +### 自定义主题色 + +```vue + +``` + +### 自定义图标插槽 + +```vue + +``` + +### 页面跳转 + +```vue + + + +``` + +### 配置 pages.json + +如果需要在 tabBar 中配置页面，需要在 `pages.json` 中配置： + +```json +{ + "tabBar": { + "color": "#999999", + "selectedColor": "#007AFF", + "backgroundColor": "#FFFFFF", + "borderStyle": "black", + "list": [ + { + "pagePath": "pages/index/index", + "text": "首页", + "iconPath": "static/icons/home.png", + "selectedIconPath": "static/icons/home-active.png" + }, + { + "pagePath": "pages/discover/index", + "text": "发现", + "iconPath": "static/icons/compass.png", + "selectedIconPath": "static/icons/compass-active.png" + } + ] + } +} +``` + +## 注意事项 + +1. **图标字体**：组件默认使用 iconfont 图标库，请确保已引入对应的图标字体文件 +2. **页面跳转**：建议在 pages.json 中配置 tabBar 页面，使用 `uni.switchTab` 跳转 +3. **徽标显示**：badge 和 dot 不能同时设置，优先显示 badge +4. **安全区适配**：iPhone X 及以上设备会自动适配底部安全区 +5. **fixed 定位**：设置为 fixed 时，组件会固定在页面底部 + +## 完整示例 + +查看 `resources/mobile/pages/example/tabbar/index.vue` 获取完整的使用示例。 + +## License + +MIT diff --git a/resources/mobile/components/sc-tabbar/index.vue b/resources/mobile/components/sc-tabbar/index.vue new file mode 100644 index 0000000..1c03f0a --- /dev/null +++ b/resources/mobile/components/sc-tabbar/index.vue @@ -0,0 +1,217 @@ + + + + + diff --git a/resources/mobile/index.html b/resources/mobile/index.html new file mode 100644 index 0000000..b5d330d --- /dev/null +++ b/resources/mobile/index.html @@ -0,0 +1,20 @@ + + + + + + + + + + +
+ + + diff --git a/resources/mobile/main.js b/resources/mobile/main.js new file mode 100644 index 0000000..782f8c2 --- /dev/null +++ b/resources/mobile/main.js @@ -0,0 +1,9 @@ +import App from './App' + +import { createSSRApp } from 'vue' +export function createApp() { + const app = createSSRApp(App) + return { + app + } +} diff --git a/resources/mobile/manifest.json b/resources/mobile/manifest.json new file mode 100644 index 0000000..6208a51 --- /dev/null +++ b/resources/mobile/manifest.json @@ -0,0 +1,72 @@ +{ + "name" : "mobile", + "appid" : "", + "description" : "", + "versionName" : "1.0.0", + "versionCode" : "100", + "transformPx" : false, + /* 5+App特有相关 */ + "app-plus" : { + "usingComponents" : true, + "nvueStyleCompiler" : "uni-app", + "compilerVersion" : 3, + "splashscreen" : { + "alwaysShowBeforeRender" : true, + "waiting" : true, + "autoclose" : true, + "delay" : 0 + }, + /* 模块配置 */ + "modules" : {}, + /* 应用发布信息 */ + "distribute" : { + /* android打包配置 */ + "android" : { + "permissions" : [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + /* ios打包配置 */ + "ios" : {}, + /* SDK配置 */ + "sdkConfigs" : {} + } + }, + /* 快应用特有相关 */ + "quickapp" : {}, + /* 小程序特有相关 */ + "mp-weixin" : { + "appid" : "", + "setting" : { + "urlCheck" : false + }, + "usingComponents" : true + }, + "mp-alipay" : { + "usingComponents" : true + }, + "mp-baidu" : { + "usingComponents" : true + }, + "mp-toutiao" : { + "usingComponents" : true + }, + "uniStatistics" : { + "enable" : false + }, + "vueVersion" : "3" +} diff --git a/resources/mobile/node_modules/.yarn-integrity b/resources/mobile/node_modules/.yarn-integrity new file mode 100644 index 0000000..81e5b58 --- /dev/null +++ b/resources/mobile/node_modules/.yarn-integrity @@ -0,0 +1,21 @@ +{ + "systemParams": "win32-x64-115", + "modulesFolders": [ + "node_modules" + ], + "flags": [], + "linkedModules": [], + "topLevelPatterns": [ + "@dcloudio/uni-ui@^1.5.11", + "luch-request@^3.1.1", + "mp-html@^2.5.2" + ], + "lockfileEntries": { + "@dcloudio/types@^2.0.16": "https://registry.npmmirror.com/@dcloudio/types/-/types-2.6.12.tgz#6c9559b9e65483f355dd61cb88fe8c14c8e61189", + "@dcloudio/uni-ui@^1.5.11": "https://registry.npmmirror.com/@dcloudio/uni-ui/-/uni-ui-1.5.11.tgz#ac4d0022e487a39f8aba68af8adf5ac437a49106", + "luch-request@^3.1.1": "https://registry.npmmirror.com/luch-request/-/luch-request-3.1.1.tgz#a62b0aab54c5acd9da5b5fd0564ed2cdb8af9c2f", + "mp-html@^2.5.2": "https://registry.npmmirror.com/mp-html/-/mp-html-2.5.2.tgz#cd86f3811d1b2fca93295624ad8d3f9f36945d97" + }, + "files": [], + "artifacts": {} +} \ No newline at end of file diff --git a/resources/mobile/node_modules/@dcloudio/types/html5plus/plus.d.ts b/resources/mobile/node_modules/@dcloudio/types/html5plus/plus.d.ts new file mode 100644 index 0000000..0a6b0be --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/html5plus/plus.d.ts @@ -0,0 +1,20694 @@ +/** + * HTML5+接口，统一浏览器自定义扩展，提供增强的功能、性能扩展规范，使得开发者可开发出跨平台的app，并接近原生的功能和性能。 + * + * 参考: [http://www.html5plus.org/doc/h5p.html](http://www.html5plus.org/doc/h5p.html) + */ +declare const plus: Plus; + +/** + * HTML5+接口，统一浏览器自定义扩展，提供增强的功能、性能扩展规范，使得开发者可开发出跨平台的app，并接近原生的功能和性能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ +interface Plus { + /** + * Accelerometer模块管理设备加速度传感器，用于获取设备加速度信息，包括x（屏幕水平方向）、y（垂直屏幕水平方向）、z（垂直屏幕平面方向）三个方向的加速度信息。通过plus.accelerometer获取设备加速度传感器管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + accelerometer: PlusAccelerometer; + /** + * AD模块实现uni-AD广告联盟功能，聚合目前国内流行的广告平台广点通（腾讯）、穿山甲（今日头条）、360广告等，支持信息流、Banner等广告。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + ad: PlusAd; + /** + * Native.js for Android封装一条通过JS语法直接调用Native Java接口通道，通过plus.android可调用几乎所有的系统API。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + android: PlusAndroid; + /** + * Audio模块用于提供音频的录制和播放功能，可调用系统的麦克风设备进行录音操作，也可调用系统的扬声器设备播放音频文件。通过plus.audio获取音频管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + audio: PlusAudio; + /** + * Bluetooth模块用于管理蓝牙设备，搜索附近蓝牙设备、实现简单数据传输等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + bluetooth: PlusBluetooth; + /** + * Camera模块管理设备的摄像头，可用于拍照、摄像操作，通过plus.camera获取摄像头管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + camera: PlusCamera; + /** + * Contacts模块管理系统通讯录，用于可对系统通讯录进行增、删、改、查等操作。通过plus.contacts获取系统通讯录管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + contacts: PlusContacts; + /** + * Device模块管理设备信息，用于获取手机设备的相关信息，如IMEI、IMSI、型号、厂商等。通过plus.device获取设备信息管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + device: PlusDevice; + /** + * Screen模块管理设备屏幕信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + screen: PlusScreen; + /** + * Display模块管理应用可使用的显示区域信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + display: PlusDisplay; + /** + * networkinfo模块用于获取网络信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + networkinfo: PlusNetworkinfo; + /** + * OS模块管理操作系统信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + os: PlusOs; + /** + * Downloader模块管理网络文件下载任务，用于从服务器下载各种文件，并支持跨域访问操作。通过plus.downloader获取下载管理对象。Downloader下载使用HTTP的GET/POST方式请求下载文件，符合标准HTTP/HTTPS传输协议。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + downloader: PlusDownloader; + /** + * Fingerprint模块管理指纹识别。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + fingerprint: PlusFingerprint; + /** + * Gallery模块管理系统相册，支持从相册中选择图片或视频文件、保存图片或视频文件到相册等功能。通过plus.gallery获取相册管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + gallery: PlusGallery; + /** + * Geolocation模块管理设备位置信息，用于获取地理位置信息，如经度、纬度等。通过plus.geolocation可获取设备位置管理对象。虽然W3C已经提供标准API获取位置信息，但在某些平台存在差异或未实现，为了保持各平台的统一性，定义此规范接口获取位置信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + geolocation: PlusGeolocation; + /** + * iBeacon模块用于搜索附件的iBeacon设备。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + ibeacon: PlusIbeacon; + /** + * IO模块管理本地文件系统，用于对文件系统的目录浏览、文件的读取、文件的写入等操作。通过plus.io可获取文件系统管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + io: PlusIo; + /** + * Native.js for iOS封装一条通过JS语法直接调用Native Objective-C接口通道，通过plus.ios可调用几乎所有的系统API。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + ios: PlusIos; + /** + * Key管理设备按键事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + key: PlusKey; + /** + * Messaging模块管理设备通讯功能，可用于短信、彩信、邮件发送等。通过plus.messaging可获取设备通讯管理对象。另外也可以直接通过html中的href直接快速发送短信、拨打电话、发送邮件等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + messaging: PlusMessaging; + /** + * nativeObj管理系统原生对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + nativeObj: PlusNativeObj; + /** + * nativeUI管理系统原生界面，可用于弹出系统原生提示对话框窗口、时间日期选择对话框、等待对话框等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + nativeUI: PlusNativeUI; + /** + * navigator用于管理浏览器运行环境信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + navigator: PlusNavigator; + /** + * Orientation模块管理设备的方向信息，包括alpha、beta、gamma三个方向信息，通过plus.orientation可获取设备方向管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + orientation: PlusOrientation; + /** + * Proximity模块管理设备距离传感器，可获取当前设备的接近距离信息，通过plus.proximity可获取设备距离传感管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/proximity.html](http://www.html5plus.org/doc/zh_cn/proximity.html) + */ + proximity: PlusProximity; + /** + * Runtime模块管理运行环境，可用于获取当前运行环境信息、与其它程序进行通讯等。通过plus.runtime可获取运行环境管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + runtime: PlusRuntime; + /** + * SQLite模块用于操作本地数据库文件，可实现数据库文件的创建，执行SQL语句等功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + sqlite: PlusSqlite; + /** + * Storage模块管理应用本地数据存储区，用于应用数据的保存和读取。应用本地数据与localStorage、sessionStorage的区别在于数据有效域不同，前者可在应用内跨域操作，数据存储期是持久化的，并且没有容量限制。通过plus.storage可获取应用本地数据管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + storage: PlusStorage; + /** + * Stream模块操作流应用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + stream: PlusStream; + /** + * Uploader模块管理网络上传任务，用于从本地上传各种文件到服务器，并支持跨域访问操作。通过plus.uploader可获取上传管理对象。Uploader上传使用HTTP的POST方式提交数据，数据格式符合Multipart/form-data规范，即rfc1867（Form-based File Upload in HTML）协议。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + uploader: PlusUploader; + /** + * Video模块管理多媒体视频相关能力，可用创建视频播放控件，直播推流控件等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + video: PlusVideo; + /** + * Webview模块管理应用窗口界面，实现多窗口的逻辑控制管理操作。通过plus.webview可获取应用界面管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + webview: PlusWebview; + /** + * XMLHttpRequest模块管理网络请求，与标准HTML中的XMLHttpRequest用途一致，差别在于前者可以进行跨域访问。通过plus.net可获取网络请求管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + net: PlusNet; + /** + * Zip模块管理文件压缩和解压，通过plus.zip可获取压缩管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + zip: PlusZip; + /** + * Barcode模块管理条码（一维码和二维码）扫描识别，支持常见的一维码（如EAN13码）及二维码（如QR码）。通过调用设备的摄像头对条码进行扫描识别，扫描到条码后进行解码并返回码数据内容及码类型。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + barcode: PlusBarcode; + /** + * Maps模块管理地图控件，用于在web页面中显示地图控件，提供各种接口操作地图控件，如添加标点、路线等。通过plus.maps可获取地图管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + maps: PlusMaps; + /** + * OAuth模块管理客户端的用户登录鉴权功能，允许应用访问第三方平台的资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + oauth: PlusOauth; + /** + * Payment模块管理支付功能，用于提供网页安全支付能力，支持通过Web接口进行支付操作。通过plus.payment可获取支付管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + payment: PlusPayment; + /** + * Push模块管理推送消息功能，可以实现在线、离线的消息推送，通过plus.push可获取推送消息管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + push: PlusPush; + /** + * Share模块管理客户端的社交分享功能，提供调用终端社交软件的分享能力。通过plus.share可获取社交分享管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + share: PlusShare; + /** + * Speech模块管理语音输入功能，提供语音识别功能，可支持用户通过麦克风设备进行语音输入内容。通过plus.speech可获取语音输入管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + speech: PlusSpeech; + /** + * Statistic模块管理统计功能，用于提供应用内统计的能力，支持统计和分析用户属性和用户行为数据。通过plus.statistic可获取统计管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/statistic.html](http://www.html5plus.org/doc/zh_cn/statistic.html) + */ + statistic: PlusStatistic; +} + +/** + * Accelerometer模块管理设备加速度传感器，用于获取设备加速度信息，包括x（屏幕水平方向）、y（垂直屏幕水平方向）、z（垂直屏幕平面方向）三个方向的加速度信息。通过plus.accelerometer获取设备加速度传感器管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ +interface PlusAccelerometer { + /** + * 设备加速度信息对象 + * JSON对象，保存获取设备的加速度信息，包括x、y、z三个方向的加速度信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + Acceleration?: PlusAccelerometerAcceleration; + /** + * 监听设备加速度感应器参数 + * JSON对象，用于设置获取设备加速度信息的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + AccelerometerOption?: PlusAccelerometerAccelerometerOption; + /** + * 获取当前设备的加速度信息 + * 加速度是设备在当前方向上所做相对运动变化（增、减量）的运动传感器。加速度信息包括x、y、z三个方向的信息。 + * 加速度信息可通过successCB回调函数返回。加速度信息获取失败则调用回调函数errorCB。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + getCurrentAcceleration(successCB: (result: PlusAccelerometerAcceleration) => void, errorCB?: (result: any) => void): void; + /** + * 监听设备加速度变化信息 + * 加速度是设备在当前方向上所做相对运动变化（增、减量）的运动传感器。加速度信息包括x、y、z三个方向的信息。 + * watchAcceleration每隔固定时间就获取一次设备的加速度信息，通过successCB回调函数返回。可通过option的frequency参数设定获取设备加速度信息的时间间隔。 + * 加速度信息获取失败则调用回调函数errorCB。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + watchAcceleration(successCB: (result: PlusAccelerometerAcceleration) => void, errorCB?: (result: any) => void, options?: PlusAccelerometerAccelerometerOption): number; + /** + * 关闭监听设备加速度信息 + * 关闭监听设备加速度信息，应用关闭调用watchAcceleration方法的开启的监听操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + clearWatch(watchId: number): void; +} + +/** + * 设备加速度信息对象 + * JSON对象，保存获取设备的加速度信息，包括x、y、z三个方向的加速度信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ +interface PlusAccelerometerAcceleration { + /** + * x轴方向的加速度 + * 获取当前设备x轴方向的加速度，浮点型数据，与物理学中的加速度值一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + xAxis?: number; + /** + * y轴方向的加速度 + * 获取当前设备y轴方向的加速度，浮点型数据，与物理学中的加速度值一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + yAxis?: number; + /** + * z轴方向的加速度 + * 获取当前设备z轴方向的加速度，浮点型数据，与物理学中的加速度值一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + zAxis?: number; +} + +/** + * 监听设备加速度感应器参数 + * JSON对象，用于设置获取设备加速度信息的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ +interface PlusAccelerometerAccelerometerOption { + /** + * 更新加速度信息间隔时间 + * 监听器获取加速度信息的时间间隔，单位为ms，默认值为500ms + * + * 参考: [http://www.html5plus.org/doc/zh_cn/accelerometer.html](http://www.html5plus.org/doc/zh_cn/accelerometer.html) + */ + frequency?: number; +} + +/** + * AD模块实现uni-AD广告联盟功能，聚合目前国内流行的广告平台广点通（腾讯）、穿山甲（今日头条）、360广告等，支持信息流、Banner等广告。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAd { + /** + * 信息流广告数据对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + AdData?: PlusAdAdData; + /** + * 广告控件对象 + *

+ * AdView从plus.nativeObj.View继承， + * 用于渲染显示广告的原生控件，目前仅支持“模板渲染”模式，暂不支持“自定义渲染”模式。 + * 使用广告控件步骤： + *

    + *
  • 创建广告控件AdView，添加到Webview中，高度设置为"0px"，此时不显示
    • + *
  • 获取广告数据，将广告数据绑定到AdView上并开始渲染
    • + *
  • 监听广告渲染事件，广告渲染成功后更新AdView的位置及高度，显示广告
    • + *
+ * 注意：广告控件创建后需添加到Webview窗口中才能显示，关闭广告。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + AdView?: PlusAdAdView; + /** + * 广告原生控件样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + AdViewStyles?: PlusAdAdViewStyles; + /** + * 获取信息流广告的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + AdsOptions?: PlusAdAdsOptions; + /** + * 内容联盟的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + ContentOptions?: PlusAdContentOptions; + /** + * 全屏视频广告对象 + *

+ * 用于管理全屏视频广告对象，调用plus.ad.createFullScreenVideoAd方法创建。 + * 需先调用load加载视频广告，加载完成后调用show显示，全屏视频广告使用原生控件渲染显示，显示层级较高。 + * HBuilderX2.9.5+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + FullScreenVideoAd?: PlusAdFullScreenVideoAd; + /** + * 创建全屏视频广告对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + FullScreenVideoAdStyles?: PlusAdFullScreenVideoAdStyles; + /** + * 插屏广告对象 + *

+ * 用于管理插屏广告对象，调用plus.ad.createInterstitialAd方法创建。 + * 需先调用load加载视频广告，加载完成后调用show显示，插屏广告使用原生控件渲染显示，显示层级较高。 + * HBuilderX3.1.10+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + InterstitialAd?: PlusAdInterstitialAd; + /** + * 创建插屏广告对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + InterstitialAdStyles?: PlusAdInterstitialAdStyles; + /** + * 激励视频广告对象 + *

+ * 用于管理激励视频广告对象，调用plus.ad.createRewardedVideoAd方法创建。 + * 需先调用load加载视频广告，加载完成后调用show显示，激励视频广告使用原生控件渲染显示，显示层级较高。 + * HBuilderX2.5.11+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + RewardedVideoAd?: PlusAdRewardedVideoAd; + /** + * 创建激励视频广告对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + RewardedVideoAdStyles?: PlusAdRewardedVideoAdStyles; + /** + * 激励视频服务器回调数据 + *

+ * HBuilderX2.6.8及以上版本仅今日头条穿山甲的激励视频广告支持服务器回调； + * HBuilderX3.1.15及以上版本今日头条穿山甲、腾讯优量汇、快手广告联盟都支持服务器回调。 + * 详细使用方法参考https://ask.dcloud.net.cn/article/37108。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + RewardVideoAdUrlCallbackDatas?: PlusAdRewardVideoAdUrlCallbackDatas; + /** + * 创建广告控件 + * 创建广告控件后不会自动显示，需要将控件添加Webview窗口中才能显示； + * 广告控件不会自动渲染广告内容，需要调用renderingBind方法绑定广告数据才会渲染； + * 完成显示后需要调用close方法关闭广告控件，释放原生资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + createAdView(styles: PlusAdAdViewStyles): PlusAdAdView; + /** + * 创建全屏视频广告 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + createFullScreenVideoAd(styles: PlusAdFullScreenVideoAdStyles): PlusAdFullScreenVideoAd; + /** + * 创建插屏广告 + *

+ * 创建插屏广告对象后不会自动加载显示，需要调用load方法才会加载； + * 加载完成后需要调用show方法显示插屏广告。 + * 完成显示后需要调用destroy方法释放原生资源。 + * HBuilderX3.1.10+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + createInterstitialAd(styles: PlusAdInterstitialAdStyles): PlusAdInterstitialAd; + /** + * 创建激励视频广告 + * HBuilderX2.5.11+版本支持。 + * 创建激励视频视频广告对象后不会自动加载显示，需要调用load方法才会加载； + * 广告加载完成后需要调用show方法显示激励视频。 + * 完成显示后需要调用destroy方法释放原生资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + createRewardedVideoAd(styles: PlusAdRewardedVideoAdStyles): PlusAdRewardedVideoAd; + /** + * 获取信息流广告数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + getAds(options: PlusAdAdsOptions, successCB?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 释放广告数据 + * 通过plus.ad.getAds方法获取广告数据后，如果不绑定的广告控件中，则需要调用此方法释放广告数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + releaseAdData(data: PlusAdAdData): void; + /** + * 设置是否显示开屏广告 + *

+ * 开通uni-AD后，关闭或开启当前设备的开屏广告。 + * 注意：HBuilderX3.0.0+版本新增支持，需单独向uni-AD申请此功设置才能生效，请发邮件到uniad@dcloud.io申请。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + setSplashAd(enable: boolean): void; + /** + * 显示内容联盟页面 + *

+ * 全屏显示视频内容联盟，目前仅支持快手内容联盟。 + * 注意：HBuilderX3.1.5+版本支持，必须勾选快手内容联盟SDK才能使用。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + showContentPage(options: PlusAdContentOptions, successCB?: () => void, errorCB?: (result: any) => void): void; +} + +/** + * 信息流广告数据对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdAdData { + /** + * 广告描述信息 + * 注意：部分广告商可能不返回此数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + description?: string; + /** + * 广告提供商标识 + *

+ * 包括以下值： + *

    + *
  • "360" - 表示广告由360广告联盟提供
    • + *
  • "csj" - 表示广告由今日头条穿山甲广告联盟提供
    • + *
  • "gdt" - 表示广告由腾讯广点通广告联盟提供
    • + *
  • "ks" - 表示广告由快手广告联盟提供
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + provider?: string; + /** + * 广告显示类型 + *

+ * 可取值： + *

    + *
  • "lage" - 大图广告
    • + *
  • "small" - 小图广告
    • + *
  • "multiple" - 多图广告
    • + *
  • "video" - 视频广告
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + showMode?: string; + /** + * 广告标题 + * 注意：部分广告商可能不返回此数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + title?: string; +} + +/** + * 广告控件对象 + *

+ * AdView从plus.nativeObj.View继承， + * 用于渲染显示广告的原生控件，目前仅支持“模板渲染”模式，暂不支持“自定义渲染”模式。 + * 使用广告控件步骤： + *

    + *
  • 创建广告控件AdView，添加到Webview中，高度设置为"0px"，此时不显示
    • + *
  • 获取广告数据，将广告数据绑定到AdView上并开始渲染
    • + *
  • 监听广告渲染事件，广告渲染成功后更新AdView的位置及高度，显示广告
    • + *
+ * 注意：广告控件创建后需添加到Webview窗口中才能显示，关闭广告。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdAdView extends PlusNativeObjView { + /** + * 绑定广告数据并渲染 + * 可通过setRenderingListener方法监听广告渲染完成事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + renderingBind(data: PlusAdAdData): void; + /** + * 监听广告渲染完成事件 + * “模板渲染”模式下有效，广告控件渲染完成时触发。 + * 回调函数中返回渲染结果，及广告显示需要的宽度及高度信息，此时需动态调整控件的高度确保广告内容正常显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + setRenderingListener(callback: (result: any) => void): void; + /** + * 监听点击关闭广告事件 + * “模板渲染”模式下有效，用户点击“关闭广告”按钮时触发。 + * 注意：用户点击此按钮并不会关闭广告控件，需要调用ADView的close方法关闭控件，释放原生资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + setDislikeListener(callback: (result: any) => void): void; + /** + * 监听点击广告事件 + *

+ * “模板渲染”模式下有效，用户点击广告跳转到落地页面时触发。 + * 注意：HBuilderX3.0.0+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + setAdClickedListener(callback: () => void): void; +} + +/** + * 广告原生控件样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdAdViewStyles { + /** + * AdView控件左上角的垂直偏移量 + *

+ * 可取值： + *

    + *
  • 像素值，如"100px"
    • + *
  • 百分比，如"10%"，相对于父Webview窗口的高度
    • + *
+ * 默认值为"0px"。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + top?: string; + /** + * AdView控件左上角的水平偏移量 + *

+ * 可取值： + *

    + *
  • 像素值，如"100px"
    • + *
  • 百分比，如"10%"，相对于父Webview窗口的宽度
    • + *
+ * 默认值为"0px"。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + left?: string; + /** + * AdView控件的宽度 + *

+ * 可取值： + *

    + *
  • 像素值，如"100px"
    • + *
  • 百分比，如"10%"，相对于父Webview窗口的宽度
    • + *
+ * 默认值为"100%"。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + width?: string; + /** + * AdView控件的高度 + *

+ * 可取值： + *

    + *
  • 像素值，如"100px"
    • + *
  • 百分比，如"10%"，相对于父Webview窗口的高度
    • + *
+ * 默认值为"0px"。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + height?: string; + /** + * AdView控件在Webview窗口的布局模式 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + position?: string; +} + +/** + * 获取信息流广告的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdAdsOptions { + /** + * 信息流广告位标识 + *

+ * 在uni-AD平台新建广告位后可得到。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + adpid?: string; + /** + * 信息流广告将要显示的宽度 + * 支持像素值（如"100px"）、百分比（如"50%"）。默认值为"100%"。 + * 注：此值用于向广告平台匹配合适的信息流广告，建议传入广告展现时真实的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + width?: string; + /** + * 获取信息流广告的数目 + * 默认值为3。 + * 注：真实返回的广告数目可能小于此值，如填充率不够时会发生此情况。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + count?: number; +} + +/** + * 内容联盟的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdContentOptions { + /** + * 信息流广告位标识 + *

+ * 在uni-AD平台新建内容联盟广告位后可得到。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + adpid?: string; + /** + * 内容联盟背景颜色 + * 格式为"#RRGGBB"，默认值为"#000000"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + background?: string; +} + +/** + * 全屏视频广告对象 + *

+ * 用于管理全屏视频广告对象，调用plus.ad.createFullScreenVideoAd方法创建。 + * 需先调用load加载视频广告，加载完成后调用show显示，全屏视频广告使用原生控件渲染显示，显示层级较高。 + * HBuilderX2.9.5+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdFullScreenVideoAd { + /** + * 销毁全屏视频广告对象 + * 释放原生层资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + destroy(): void; + /** + * 广告提供商标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + getProvider(): string; + /** + * 加载全屏视频广告 + *

+ * 全屏视频广告加载完成会触发onLoad设置的监听回调。 + * 注意：广告加载成功后，长时间不显示可能会过期，因此不建议预加载广告 + *

    + *
  • 广点通 - 有效时间大概为0.5小时，过期后显示（show）会触发错误回调，错误码为-5008
    • + *
  • 穿山甲 - 有效时间大概为1小时，过期后依然可以显示，但不会算收益
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + load(): void; + /** + * 取消监听用户点击广告的事件 + *

+ * 取消后用户点击全屏视频广告打开落地页时不再触发回调。 + * 注意：HBuilderX3.0.0+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offAdClick(callback: () => void): void; + /** + * 取消监听用户点击“关闭广告”按钮的事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offClose(callback: (result: any) => void): void; + /** + * 取消监听全屏视频错误事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offError(callback: (result: any) => void): void; + /** + * 取消监听全屏视频广告加载事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offLoad(callback: () => void): void; + /** + * 监听用户点击广告的事件 + *

+ * 用户点击全屏视频广告打开落地页时触发回调。 + * 注意：HBuilderX3.0.0+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onAdClick(callback: () => void): void; + /** + * 监听用户点击“关闭广告”按钮的事件 + *

+ * 用户点击全屏视频广告页面中的“关闭广告”按钮时触发，回调参数为JSON对象，包括以下属性： + *

    + *
  • isEnded - Boolean类型，
    • + *
+ * 可通过回调参数的isEnded属性判断视频是否是在用户完整观看的情况下被关闭的。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onClose(callback: (result: any) => void): void; + /** + * 监听全屏视频错误事件 + * 全屏视频广告加载或显示失败时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onError(callback: (result: any) => void): void; + /** + * 监听全屏视频广告加载事件 + * 全屏视频广告加载完成时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onLoad(callback: () => void): void; + /** + * 显示全屏视频广告 + * 显示全屏视频广告。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + show(): void; +} + +/** + * 创建全屏视频广告对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdFullScreenVideoAdStyles { + /** + * 全屏视频广告位标识 + *

+ * 在uni-AD平台新建全屏视频类型广告位后可得到。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + adpid?: string; +} + +/** + * 插屏广告对象 + *

+ * 用于管理插屏广告对象，调用plus.ad.createInterstitialAd方法创建。 + * 需先调用load加载视频广告，加载完成后调用show显示，插屏广告使用原生控件渲染显示，显示层级较高。 + * HBuilderX3.1.10+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdInterstitialAd { + /** + * 销毁插屏广告对象 + * 释放原生层资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + destroy(): void; + /** + * 广告提供商标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + getProvider(): string; + /** + * 加载插屏广告 + *

+ * 插屏广告加载完成会触发onLoad设置的监听回调。 + * 注意：广告加载成功后，长时间不显示可能会过期，因此不建议预加载广告 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + load(): void; + /** + * 取消监听用户点击广告的事件 + *

+ * 取消后用户点击插屏广告打开落地页时不再触发回调事件。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offAdClick(callback: () => void): void; + /** + * 取消监听用户点击“关闭广告”按钮的事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offClose(callback: () => void): void; + /** + * 取消监听插屏错误事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offError(callback: (result: any) => void): void; + /** + * 取消监听插屏广告加载事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offLoad(callback: () => void): void; + /** + * 监听用户点击广告的事件 + *

+ * 用户点击插屏广告打开落地页时触发回调。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onAdClick(callback: () => void): void; + /** + * 监听用户关闭广告事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onClose(callback: () => void): void; + /** + * 监听插屏广告错误事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onError(callback: (result: any) => void): void; + /** + * 监听插屏广告加载事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onLoad(callback: () => void): void; + /** + * 显示插屏广告 + * 显示插屏广告。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + show(): void; +} + +/** + * 创建插屏广告对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdInterstitialAdStyles { + /** + * 插屏广告位标识 + *

+ * 在uni-AD平台新建广告位后可得到。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + adpid?: string; + /** + * 视频广告时是否静音 + *

+ * 可取值： + *

    + *
  • true - 视频类型广告静音
    • + *
  • false - 视频类型广告不静音
    • + *
+ * 默认值为true，即默认为静音。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + videoMuted?: boolean; +} + +/** + * 激励视频广告对象 + *

+ * 用于管理激励视频广告对象，调用plus.ad.createRewardedVideoAd方法创建。 + * 需先调用load加载视频广告，加载完成后调用show显示，激励视频广告使用原生控件渲染显示，显示层级较高。 + * HBuilderX2.5.11+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdRewardedVideoAd { + /** + * 销毁激励视频广告对象 + * 释放原生层资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + destroy(): void; + /** + * 广告提供商标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + getProvider(): string; + /** + * 加载激励视频广告 + *

+ * 激励视频广告加载完成会触发onLoad设置的监听回调。 + * 注意：广告加载成功后，长时间不显示可能会过期，因此不建议预加载广告 + *

    + *
  • 广点通 - 有效时间大概为0.5小时，过期后显示（show）会触发错误回调，错误码为-5008
    • + *
  • 穿山甲 - 有效时间大概为1小时，过期后依然可以显示，但不会算收益
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + load(): void; + /** + * 取消监听用户点击广告的事件 + *

+ * 取消后用户点击激励视频广告打开落地页时不再触发回调。 + * 注意：HBuilderX3.0.0+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offAdClick(callback: () => void): void; + /** + * 取消监听用户点击“关闭广告”按钮的事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offClose(callback: (result: any) => void): void; + /** + * 取消监听激励视频广告错误事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offError(callback: (result: any) => void): void; + /** + * 取消监听激励视频广告加载事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offLoad(callback: () => void): void; + /** + * 取消监听激励视频服务器回调校验事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + offVerify(callback: () => void): void; + /** + * 监听用户点击广告的事件 + *

+ * 用户点击激励视频广告打开落地页时触发回调。 + * 注意：HBuilderX3.0.0+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onAdClidk(callback: () => void): void; + /** + * 监听用户点击“关闭广告”按钮的事件 + *

+ * 用户点击激励视频广告页面中的“关闭广告”按钮时触发，回调参数为JSON对象，包括以下属性： + *

    + *
  • isEnded - Boolean类型，
    • + *
+ * 可通过回调参数的isEnded属性判断视频是否是在用户完整观看的情况下被关闭的。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onClose(callback: (result: any) => void): void; + /** + * 监听激励视频错误事件 + * 激励视频广告加载或显示失败时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onError(callback: (result: any) => void): void; + /** + * 监听激励视频广告加载事件 + * 激励视频广告加载完成时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onLoad(callback: () => void): void; + /** + * 监听激励视频广告服务器回调校验事件 + *

+ * 激励视频广告服务器回调校验完成时触发，回调参数为JSON对象，包括以下属性： + *

    + *
  • isValid - Boolean类型，服务器回调校验结果，true表示服务器回调校验成功，false表示服务器回调校验失败
    • + *
+ * 注意：HBuilderX2.7.0+版本支持，仅今日头条穿山甲广告支持服务器回调，详情参考：https://ask.dcloud.net.cn/article/37108 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + onVerify(callback: () => void): void; + /** + * 显示激励视频广告 + * 全屏显示激励视频广告。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + show(): void; +} + +/** + * 创建激励视频广告对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdRewardedVideoAdStyles { + /** + * 激励视频广告位标识 + *

+ * 在uni-AD平台新建广告位后可得到。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + adpid?: string; + /** + * 激励视频服务器回调数据 + *

+ * HBuilderX2.6.8及以上版本仅今日头条穿山甲的激励视频广告支持服务器回调； + * HBuilderX3.1.15及以上版本今日头条穿山甲、腾讯优量汇、快手广告联盟都支持服务器回调。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + urlCallback?: PlusAdRewardVideoAdUrlCallbackDatas; +} + +/** + * 激励视频服务器回调数据 + *

+ * HBuilderX2.6.8及以上版本仅今日头条穿山甲的激励视频广告支持服务器回调； + * HBuilderX3.1.15及以上版本今日头条穿山甲、腾讯优量汇、快手广告联盟都支持服务器回调。 + * 详细使用方法参考https://ask.dcloud.net.cn/article/37108。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ +interface PlusAdRewardVideoAdUrlCallbackDatas { + /** + * 奖励数量（已废弃） + * 在uni-AD后台的广告位管理中设置奖励数量。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + amount?: string; + /** + * 透传参数 + * 应用业务系统中扩展数据，服务器回调时透传。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + extra?: string; + /** + * 奖励名称（已废弃） + * 在uni-AD后台的广告位管理中设置奖励名称。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + name?: string; + /** + * 用户id + * 应用业务系统中当前用户的标识，服务器回调时透传。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ad.html](http://www.html5plus.org/doc/zh_cn/ad.html) + */ + userId?: string; +} + +/** + * Native.js for Android封装一条通过JS语法直接调用Native Java接口通道，通过plus.android可调用几乎所有的系统API。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ +interface PlusAndroid { + /** + * Java类对象 + * Java类对象，可通过其属性获取类的常量，可通过方法来操作类的静态变量和方法，也通过new方法来创建类的实例对象。 + * 对于类的常量，则直接通过.后面跟随常量名称调用即可。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + ClassObject?: PlusAndroidClassObject; + /** + * Java实例对象 + * Java实例对象，可通过其方法来操作实例的变量和方法。 + * 注意：必须通过plusGetAttribute()方法读取实例对象的属性值，通过plusSetAttribute()方法设置实例对象的属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + InstanceObject?: PlusAndroidInstanceObject; + /** + * 获取当前Webview窗口对象的native层实例对象 + * Android平台完整Java类名为android.webkit.Webview，完整API请参考Android开发文档 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + currentWebview(): PlusAndroidInstanceObject; + /** + * 创建实例对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + newObject(classname: string, args?: any): PlusAndroidInstanceObject; + /** + * 获取对象（类对象/实例对象）的属性值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + getAttribute(obj: PlusAndroidInstanceObject | PlusAndroidClassObject | string, name: string): any; + /** + * 设置对象（类对象/实例对象）的属性值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + setAttribute(obj: PlusAndroidInstanceObject, name: string, value: any): void; + /** + * 实现Interface的方法 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + implements(name: string, obj: any): PlusAndroidInstanceObject; + /** + * 导入Java类对象 + * 导入类对象后，就可以通过.操作符直接调用对象（类对象/实例对象）的方法。 + * 注意：导入类对象将会消耗较多的系统资源，通常不应该导入过多的类对象，可以使用plus.android.invoke()来调用未导入类实例对象的方法。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + importClass(classname: string | PlusAndroidInstanceObject): PlusAndroidClassObject; + /** + * 调用对象（类对象/实例对象）的方法 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + invoke(obj: PlusAndroidInstanceObject | PlusAndroidClassObject | string, name: string, args?: any): any; + /** + * 请求权限 + *

+ * 向系统请求权限，Android系统6+版本（API等级23+），并且必须设置targetSdkVersion>=23，参考：https://ask.dcloud.net.cn/article/193。 + * 如果权限属于危险权限并且用户没有授权则会弹出系统提示框由用户授权确认，如果已经授权或被用户拒绝则返回结果。 + * 授权结果在successCb回调参数中可获取。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + requestPermissions(permissions?: string [], successCb?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 获取应用主Activity实例对象 + * Android平台完整Java类名为android.app.Activity，完整API请参考Android开发文档 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + runtimeMainActivity(): PlusAndroidInstanceObject; + /** + * 自动回收对象 + * 回收对象，设置自动回收原生对象（变量置空），应用在内存回收（GC）时自动释放对象占用的资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + autoCollection(obj: PlusAndroidInstanceObject): void; +} + +/** + * Java类对象 + * Java类对象，可通过其属性获取类的常量，可通过方法来操作类的静态变量和方法，也通过new方法来创建类的实例对象。 + * 对于类的常量，则直接通过.后面跟随常量名称调用即可。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ +interface PlusAndroidClassObject { + /** + * 获取Java类对象的静态属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + plusGetAttribute(name: string): any; + /** + * 设置Java类对象的静态属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + plusSetAttribute(name: string, value: any): void; +} + +/** + * Java实例对象 + * Java实例对象，可通过其方法来操作实例的变量和方法。 + * 注意：必须通过plusGetAttribute()方法读取实例对象的属性值，通过plusSetAttribute()方法设置实例对象的属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ +interface PlusAndroidInstanceObject { + /** + * 获取Java实例对象的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + plusGetAttribute(name: string): any; + /** + * 设置Java实例对象的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/android.html](http://www.html5plus.org/doc/zh_cn/android.html) + */ + plusSetAttribute(name: string, value: any): void; +} + +/** + * Audio模块用于提供音频的录制和播放功能，可调用系统的麦克风设备进行录音操作，也可调用系统的扬声器设备播放音频文件。通过plus.audio获取音频管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ +interface PlusAudio { + /** + * 录音对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + AudioRecorder?: PlusAudioAudioRecorder; + /** + * 音频播放对象 + * 音频播放对象，用于音频文件的播放。不能通过new方法直接创建，只能通过audio.createPlayer方法创建。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + AudioPlayer?: PlusAudioAudioPlayer; + /** + * 音频播放控件事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + AudioPlayerEvent?: PlusAudioAudioPlayerEvent; + /** + * 音频播放对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + AudioPlayerStyles?: PlusAudioAudioPlayerStyles; + /** + * 音频录制的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + AudioRecorderStyles?: PlusAudioAudioRecorderStyles; + /** + * 设备的扬声器音频输出线路 + * 音频输出线路常量，值为0。音频播放时在设备的扬声器输出。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + ROUTE_SPEAKER?: number; + /** + * 设备听筒音频输出线路 + * 音频输出线路常量，值为1。音频播放时在设备的听筒输出。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + ROUTE_EARPIECE?: number; + /** + * 获取当前设备的录音对象 + * 获取当前设备的录音对象，进行录音操作，录音对象是设备的独占资源，在同一时间仅可执行一个录音操作，否则可能会导致操作失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + getRecorder(): PlusAudioAudioRecorder; + /** + * 创建音频播放器对象 + * 用于播放音频文件，可以直接传入音频文件地址或音频播放参数对象AudioPlayerStyles。 + * 返回播放对象，可调用其play方法开始播放。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + createPlayer(styles: PlusAudioAudioPlayerStyles | string): PlusAudioAudioPlayer; +} + +/** + * 录音对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ +interface PlusAudioAudioRecorder { + /** + * 数组，设备录音支持的采样率 + * 属性类型为Array(String)，若不支持此属性则返回空数组对象。支持的录音采样率，字符串格式为“采样频率”，如“8000”；其单位为Hz。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + supportedSamplerates?: string; + /** + * 数组，设备录音支持的文件格式 + * 属性类型为Array(String)，若不支持此属性则返回空数组对象。支持的录音文件的格式，字符串格式为文件格式后缀名，如"mp3"、"aac"、"wav"等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + supportedFormats?: string; + /** + * 调用设备麦克风进行录音操作 + * 调用设备麦克风开始录音操作，录音完成需调用stop方法停止。录音完成后将通过successCB回调返回录音后的文件数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + record(styles: PlusAudioAudioRecorderStyles, successCB: (result: string) => void, errorCB?: (result: any) => void): void; + /** + * 结束录音操作 + * 结束录音操作，通知设备完成录音操作。录音完成后将调用record方法中传入的successCB回调返回录音文件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + stop(): void; +} + +/** + * 音频播放对象 + * 音频播放对象，用于音频文件的播放。不能通过new方法直接创建，只能通过audio.createPlayer方法创建。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ +interface PlusAudioAudioPlayer { + /** + * 添加事件监听器 + * 向音频播放对象添加事件监听器，当指定的事件发生时，将触发listener函数的执行。 + * 可多次调用此方法添加多个监听器，当监听的事件发生时，将按照添加的先后顺序执行。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + addEventListener(event: 'canplay' | 'play' | 'pause' | 'stop' | 'ended' | 'error' | 'waiting' | 'seeking' | 'seeked', listener: (result: any) => void, capture?: boolean): void; + /** + * 关闭音频播放对象 + * 关闭操作将释放音频播放对象所占用的资源，关闭后不再可用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + close(): void; + /** + * 音频缓冲的时间点 + * 表示当前播放时间点到此时间点内容已缓冲。 + * 单位为秒（s），，返回值可能是小数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + getBuffered(): number; + /** + * 获取音频的总长度 + * 单位为秒（s），返回值可能是小数，若长度未知则返回-1。 + * 如果还未获取到音频流信息则返回NaN，此时需要延迟获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + getDuration(): number; + /** + * 获取音频的当前播放位置 + * 获取音频流当前播放的位置（已播放的长度），单位为秒（s），返回值可能是小数。 + * 如果当前还未开始播放则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + getPosition(): number; + /** + * 音频播放的参数 + *

+ * 获取指定key的参数值，key取值范围为AudioPlayerStyles的所有参数。 + * 如果未设置key的参数，参数有默认值则返回默认，无默认值则返回undefined。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + getStyles(key?: string): any; + /** + * 当前是否暂停或停止状态 + * 当前音频为暂停或停止状态则返回true，否则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + isPaused(): boolean; + /** + * 播放音频 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + play(successCB?: () => void, errorCB?: (result: any) => void): void; + /** + * 暂停播放 + * 当前处于播放状态才能暂停，否则调用此方法无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + pause(): void; + /** + * 移除事件监听器 + * 从音频播放对象中移除通过addEventListener方法添加的事件监听器，若没有查找到对应的事件监听器，则无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + removeEventListener(event: 'canplay' | 'play' | 'pause' | 'stop' | 'ended' | 'error' | 'waiting' | 'seeking' | 'seeked', listener: (result: any) => void): void; + /** + * 恢复播放 + * 当前处于暂停状态从暂停处开始恢复播放，非暂停状态调用此方法无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + resume(): void; + /** + * 跳到指定位置 + * 当前处于播放或暂停状态才能跳到指定播放位置，否则调用此方法无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + seekTo(position: number): void; + /** + * 停止播放 + * 当前处于播放或暂停状态才能停止播放，否则调用此方法无任何作用。 + * 停止的音频再播放会从头开始播放。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + stop(): void; + /** + * 音频输出线路 + * 可取值： + * plus.audio.ROUTE_SPEAKER - 使用设备的扬声器输出； + * plus.audio.ROUTE_EARPIECE - 使用设备的听筒输出。 + * 默认值为plus.audio.ROUTE_SPEAKER。 + * 可在音频文件开始播放前或播放过程中改变音频输出线路。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + setRoute(route: PlusAudio['ROUTE_SPEAKER'] | PlusAudio['ROUTE_EARPIECE']): void; + /** + * 设置音频播放模式 + * 可设置是否和其它音频同时输出。 + * 注意：必须在调用play方法前设置才生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + setSessionCategory(category: string): void; + /** + * 设置音频播放的参数 + * 用于动态更新音频播放的参数。 + * · + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + setStyles(styles?: PlusAudioAudioPlayerStyles): void; +} + +/** + * 音频播放控件事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ +interface PlusAudioAudioPlayerEvent { + /** + * 音频可以播放事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + canplay?: string; + /** + * 音频播放事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + play?: string; + /** + * 音频暂停事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + pause?: string; + /** + * 音频停止事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + stop?: string; + /** + * 音频自然播放结束事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + ended?: string; + /** + * 音频播放错误事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + error?: string; + /** + * 音频加载中事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + waiting?: string; + /** + * 音频进行seek操作事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + seeking?: string; + /** + * 音频完成seek操作事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + seeked?: string; + /** + * 上一曲操作事件 + * 用户在后台播放控制器上点击上一曲按钮时触发，未开启后台控制器则不触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + prev?: string; + /** + * 下一曲操作事件 + * 用户在后台播放控制器上点击下一曲按钮时触发，未开启后台控制器则不触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + next?: string; +} + +/** + * 音频播放对象的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ +interface PlusAudioAudioPlayerStyles { + /** + * 是否自动开始播放 + * true - 自动开始播放； + * false - 不自动开始播放。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + autoplay?: boolean; + /** + * 是否开启后台控制器 + * 开启后应用切换到后台可继续播放音频。 + * iOS平台在系统锁屏界面显示播放控件；Android平台暂不支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + backgroundControl?: boolean; + /** + * 封面图地址 + * 在后台播放控制器上显示，未开启后台控制器则不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + coverImgUrl?: string; + /** + * 专辑名 + * 在后台播放控制器上显示，未开启后台控制器则不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + epname?: string; + /** + * 是否循环播放 + * true - 循环播放； + * false - 不循环播放。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + loop?: boolean; + /** + * 歌手名 + * 在后台播放控制器上显示，未开启后台控制器则不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + singer?: string; + /** + * 音频资源的地址 + * 支持本地路径和网络路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + src?: string; + /** + * 开始播放的位置 + * 单位为秒（s），默认值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + startTime?: number; + /** + * 音频标题 + * 在后台播放控制器上显示，未开启后台控制器则不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + title?: string; + /** + * 音量 + * 取值范围为0-1，默认值为1。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + volume?: number; +} + +/** + * 音频录制的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ +interface PlusAudioAudioRecorderStyles { + /** + * 录音声道 + * 可取值： + * "mono" - 单声道录音； + * "stereo" - 立体声道录音。 + * 默认值为"mono"。 + * - mono: 单声道录音 + * - stereo: 立体声录音 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + channels?: 'mono' | 'stereo'; + /** + * 保存录音文件的路径 + * 可设置具体文件名，也可只设置路径，如果以“/”结尾则表明是路径，文件名由录音程序自动生成。 + * 如未设置则使用默认目录生成随机文件名称，默认目录为应用%APPID%下的documents目录。 + * - _www/: 应用资源目录 + * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + filename?: string; + /** + * 录音文件的采样率 + * 需通过supportedSamplerates属性获取设备支持的采样率，若设置无效的值，则使用系统默认的采样率。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + samplerate?: string; + /** + * 录音文件的格式 + * 需通过supportedFormats属性获取设备支持的录音格式，若设置无效的值，则使用系统默认的录音格式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/audio.html](http://www.html5plus.org/doc/zh_cn/audio.html) + */ + format?: string; +} + +/** + * Bluetooth模块用于管理蓝牙设备，搜索附近蓝牙设备、实现简单数据传输等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetooth { + /** + * 蓝牙设备信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + BluetoothDeviceInfo?: PlusBluetoothBluetoothDeviceInfo; + /** + * 蓝牙设备服务信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + BluetoothService?: PlusBluetoothBluetoothService; + /** + * 蓝牙设备特征值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + Bluetoothcharacteristic?: PlusBluetoothBluetoothcharacteristic; + /** + * 蓝牙设备特征值支持的操作类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + BluetoothcharacteristicProperties?: PlusBluetoothBluetoothcharacteristicProperties; + /** + * 关闭蓝牙模块 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + closeBluetoothAdapterOptions?: PlusBluetoothCloseBluetoothAdapterOptions; + /** + * 获取本机蓝牙适配器状态 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBluetoothAdapterStateOptions?: PlusBluetoothGetBluetoothAdapterStateOptions; + /** + * 获取已搜索到的蓝牙设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBluetoothDevicesOptions?: PlusBluetoothGetBluetoothDevicesOptions; + /** + * 根据uuid获取处于已连接的设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getConnectedBluetoothDevicesOptions?: PlusBluetoothGetConnectedBluetoothDevicesOptions; + /** + * 初始化蓝牙模块 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + openBluetoothAdapterOptions?: PlusBluetoothOpenBluetoothAdapterOptions; + /** + * 开始搜索附近的蓝牙设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + startBluetoothDevicesDiscoveryOptions?: PlusBluetoothStartBluetoothDevicesDiscoveryOptions; + /** + * 停止搜寻附近的蓝牙外围设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + stopBluetoothDevicesDiscoveryOptions?: PlusBluetoothStopBluetoothDevicesDiscoveryOptions; + /** + * 断开与低功耗蓝牙设备的连接 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + closeBLEConnectionOptions?: PlusBluetoothCloseBLEConnectionOptions; + /** + * 连接低功耗蓝牙设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + createBLEConnectionOptions?: PlusBluetoothCreateBLEConnectionOptions; + /** + * 设置蓝牙最大传输单元 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + setBLEMTUOptions?: PlusBluetoothSetBLEMTUOptions; + /** + * 获取蓝牙设备指定服务中所有特征值(characteristic) 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBLEDeviceCharacteristicsOptions?: PlusBluetoothGetBLEDeviceCharacteristicsOptions; + /** + * 获取蓝牙设备的信号强度 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBLEDeviceRSSIOptions?: PlusBluetoothGetBLEDeviceRSSIOptions; + /** + * 获取蓝牙设备的所有服务(service) 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBLEDeviceServicesOptions?: PlusBluetoothGetBLEDeviceServicesOptions; + /** + * 启用低功耗蓝牙设备特征值变化时的notify功能，订阅特征值 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + notifyBLECharacteristicValueChangeOptions?: PlusBluetoothNotifyBLECharacteristicValueChangeOptions; + /** + * 读取低功耗蓝牙设备指定特征值的二进制数据值 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + readBLECharacteristicValueOptions?: PlusBluetoothReadBLECharacteristicValueOptions; + /** + * 向低功耗蓝牙设备指定特征值写入二进制数据 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + writeBLECharacteristicValueOptions?: PlusBluetoothWriteBLECharacteristicValueOptions; + /** + * 关闭蓝牙模块 + * 断开所有已经建立的连接，释放系统资源，要求在蓝牙功能使用完成后调用（于openBluetoothAdapter成对使用）。 + * 关闭成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + closeBluetoothAdapter(options: PlusBluetoothCloseBluetoothAdapterOptions): void; + /** + * 获取本机蓝牙适配器状态 + * 获取成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBluetoothAdapterState(options: PlusBluetoothGetBluetoothAdapterStateOptions): void; + /** + * 获取已搜索到的蓝牙设备 + * 包括已经和本机处于连接状态的设备。 + * 获取成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBluetoothDevices(options: PlusBluetoothGetBluetoothDevicesOptions): void; + /** + * 根据uuid获取处于已连接的设备 + * 获取成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getConnectedBluetoothDevices(options: PlusBluetoothGetConnectedBluetoothDevicesOptions): void; + /** + * 监听蓝牙适配器状态变化事件 + * 蓝牙适配器状态发生变化时触发回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + onBluetoothAdapterStateChange(changeCB: (result: any) => void): void; + /** + * 监听搜索到新设备的事件 + * 搜索到新设备时触发回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + onBluetoothDeviceFound(callback: (result: any) => void): void; + /** + * 初始化蓝牙模块 + * 初始化成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + openBluetoothAdapter(options: PlusBluetoothOpenBluetoothAdapterOptions): void; + /** + * 开始搜索附近的蓝牙设备 + * 此操作比较耗费系统资源，请在搜索并连接到设备后调用stopBluetoothDevicesDiscovery方法停止搜索。 + * 搜索成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + startBluetoothDevicesDiscovery(options: PlusBluetoothStartBluetoothDevicesDiscoveryOptions): void; + /** + * 停止搜寻附近的蓝牙外围设备 + * 若已经找到需要的蓝牙设备并不需要继续搜索时，应该调用该接口停止蓝牙搜索。 + * 停止成功后触发options参数中的success回调，失败触发options参数中的fail回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + stopBluetoothDevicesDiscovery(options: PlusBluetoothStopBluetoothDevicesDiscoveryOptions): void; + /** + * 断开与低功耗蓝牙设备的连接 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + closeBLEConnection(options: PlusBluetoothCloseBLEConnectionOptions): void; + /** + * 连接低功耗蓝牙设备 + * 若之前已有搜索过某个蓝牙设备，并成功建立连接，可直接传入之前搜索获取的deviceId尝试连接该设备，无需进行搜索操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + createBLEConnection(options: PlusBluetoothCreateBLEConnectionOptions): void; + /** + * 设置蓝牙最大传输单元 + * 需在 createBLEConnection 调用成功后调用，mtu 设置范围 (22,512)。 + * HBuilderX2.8.4+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + setBLEMTU(options: PlusBluetoothSetBLEMTUOptions): void; + /** + * 获取蓝牙设备指定服务中所有特征值(characteristic) + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBLEDeviceCharacteristics(options: PlusBluetoothGetBLEDeviceCharacteristicsOptions): void; + /** + * 获取蓝牙设备的信号强度 + * 需在 createBLEConnection 调用成功后调用。 + * HBuilderX2.8.4+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBLEDeviceRSSI(options: PlusBluetoothGetBLEDeviceRSSIOptions): void; + /** + * 获取蓝牙设备的所有服务(service) + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + getBLEDeviceServices(options: PlusBluetoothGetBLEDeviceServicesOptions): void; + /** + * 启用低功耗蓝牙设备特征值变化时的notify功能，订阅特征值 + * 蓝牙设备服务的特征值必须支持notify或indicate才可以成功调用。 + * 另外，必须先启用notifyBLECharacteristicValueChange才能监听到设备characteristicValueChange事件,即特征值发生变化时通过onBLECharacteristicValueChange注册的事件回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + notifyBLECharacteristicValueChange(options: PlusBluetoothNotifyBLECharacteristicValueChangeOptions): void; + /** + * 监听低功耗蓝牙设备的特征值变化事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + onBLECharacteristicValueChange(callback: (result: any) => void): void; + /** + * 监听低功耗蓝牙设备连接状态变化事件 + * 包括开发者主动连接或断开连接，设备丢失，连接异常断开等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + onBLEConnectionStateChange(callback: (result: any) => void): void; + /** + * 读取低功耗蓝牙设备指定特征值的二进制数据值 + * 指定的特征值需支持read操作才可以成功调用。 + * 并行调用多次可能导致读取失败，读取的数据需要在onBLECharacteristicValueChange方法注册的回调中获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + readBLECharacteristicValue(options: PlusBluetoothReadBLECharacteristicValueOptions): void; + /** + * 向低功耗蓝牙设备指定特征值写入二进制数据 + * 指定的特征值需支持write操作才可以成功调用。 + * 并行调用多次可能导致读取失败，系统可能会限制单次传输的数据大小，超过最大字节数后可能会发生写入错误，建议每次写入不超过20字节。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + writeBLECharacteristicValue(options: PlusBluetoothWriteBLECharacteristicValueOptions): void; +} + +/** + * 蓝牙设备信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothBluetoothDeviceInfo { + /** + * 蓝牙设备名称 + * 某些设备可能没有此字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + name?: string; + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 蓝牙设备的信号强度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + RSSI?: number; + /** + * 蓝牙设备的广播数据段中的ManufacturerData数据段 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + advertisData?: ArrayBuffer; + /** + * 蓝牙设备的广播数据段中的ServiceUUIDs数据段 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + advertisServiceUUIDs?: string []; + /** + * 蓝牙设备的广播数据段中的LocalName数据段 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + localName?: string; + /** + * 蓝牙设备的广播数据段中的ServiceData数据段 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + serviceData?: any; +} + +/** + * 蓝牙设备服务信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothBluetoothService { + /** + * 蓝牙设备服务的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + uuid?: string; + /** + * 是否为设备的主服务 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + isPrimary?: boolean; +} + +/** + * 蓝牙设备特征值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothBluetoothcharacteristic { + /** + * 蓝牙设备特征值的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + uuid?: string; + /** + * 设备特征值支持的操作类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + properties?: PlusBluetoothBluetoothcharacteristicProperties; +} + +/** + * 蓝牙设备特征值支持的操作类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothBluetoothcharacteristicProperties { + /** + * 特征值是否支持read操作 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + read?: boolean; + /** + * 特征值是否支持write操作 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + write?: boolean; + /** + * 特征值是否支持notify操作 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + notify?: boolean; + /** + * 特征值是否支持indicate操作 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + indicate?: boolean; +} + +/** + * 关闭蓝牙模块 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothCloseBluetoothAdapterOptions { + /** + * 关闭蓝牙模块成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 关闭蓝牙模块失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 关闭蓝牙模块操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取本机蓝牙适配器状态 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothGetBluetoothAdapterStateOptions { + /** + * 获取蓝牙适配器状态成功回调函数 + * 回调函数参数event对象包括以下属性： + * discovering - Boolean类型，蓝牙适配器是否正在搜索设备； + * available - Boolean类型，蓝牙适配器是否可用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 获取蓝牙适配器状态错误回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 获取蓝牙适配器状态操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取已搜索到的蓝牙设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothGetBluetoothDevicesOptions { + /** + * 获取蓝牙设备成功回调函数 + * 回调函数参数event对象包括以下属性： + * devices - Array<Object>，设备列表信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 获取蓝牙设备失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 获取蓝牙设备操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 根据uuid获取处于已连接的设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothGetConnectedBluetoothDevicesOptions { + /** + * 要获取设备的uuid列表 + * 蓝牙设备主service的uuid列表。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + services?: string []; + /** + * 获取已连接设备成功回调函数 + * 回调函数参数event对象包括以下属性： + * devices - Array<BluetoothDeviceInfo>，设备列表信息（只包含name和deviceId属性）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 获取已连接设备失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 获取已连接设备操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 初始化蓝牙模块 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothOpenBluetoothAdapterOptions { + /** + * 初始化成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 初始化失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 初始化操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 开始搜索附近的蓝牙设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothStartBluetoothDevicesDiscoveryOptions { + /** + * 要获取设备的uuid列表 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + services?: string []; + /** + * 是否允许重复上报同一设备 + * 如果允许重复上报，则onBlueToothDeviceFound方法会多次上报同一设备，但是RSSI值会有不同。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + allowDuplicatesKey?: boolean; + /** + * 上报设备的间隔 + * 0表示找到新设备立即上报，其他数值根据传入的间隔上报。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + interval?: number; + /** + * 开始搜索成功回调函数 + * 搜索到设备后通过onBluetoothDeviceFound设置的回调返回设备信息，此回调只是表明开始搜索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 开始搜索失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 开始搜索操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 停止搜寻附近的蓝牙外围设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothStopBluetoothDevicesDiscoveryOptions { + /** + * 停止搜寻成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 停止搜寻失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 停止搜寻操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 断开与低功耗蓝牙设备的连接 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothCloseBLEConnectionOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 断开连接成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 断开连接失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 断开连接操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 连接低功耗蓝牙设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothCreateBLEConnectionOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 超时时间 + * 单位为ms（毫秒），不设置此属性表示不会超时。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + timeout?: number; + /** + * 连接成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 连接失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 连接操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 设置蓝牙最大传输单元 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothSetBLEMTUOptions { + /** + * 设备的 id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 最大传输单元(22,512) 区间内，单位为字节（bytes） + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + mtu?: number; + /** + * 设置蓝牙最大传输单元成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 设置蓝牙最大传输单元失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 设置蓝牙最大传输单元操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取蓝牙设备指定服务中所有特征值(characteristic) 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothGetBLEDeviceCharacteristicsOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 蓝牙服务 uuid + * 可通过getBLEDeviceServices获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + serviceId?: string; + /** + * 获取特征值成功回调函数 + * 回调函数参数event对象包括以下属性： + * characteristics - Array>Bluetoothcharacteristic<类型，蓝牙设备服务的特征值列表。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 获取特征值失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 获取特征值操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取蓝牙设备的信号强度 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothGetBLEDeviceRSSIOptions { + /** + * 设备的 id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 获取蓝牙设备信号强度成功回调函数 + * 回调函数参数event对象包括以下属性： + * RSSI - Number类型，蓝牙设备的信号强度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 获取蓝牙设备信号强度失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 获取蓝牙设备信号强度操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取蓝牙设备的所有服务(service) 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothGetBLEDeviceServicesOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 获取服务成功回调函数 + * 回调函数参数event对象包括以下属性： + * services - Array>BluetoothService<类型，蓝牙设备服务的特征值列表。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 获取服务失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 获取服务操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 启用低功耗蓝牙设备特征值变化时的notify功能，订阅特征值 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothNotifyBLECharacteristicValueChangeOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 蓝牙服务的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + serviceId?: string; + /** + * 蓝牙特征值的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + characteristicId?: string; + /** + * 是否启用 notify + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + state?: boolean; + /** + * 订阅特征值成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 订阅特征值失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 订阅特征值操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 读取低功耗蓝牙设备指定特征值的二进制数据值 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothReadBLECharacteristicValueOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 蓝牙服务的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + serviceId?: string; + /** + * 蓝牙特征值的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + characteristicId?: string; + /** + * 读取特征值的二进制数据成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 读取特征值的二进制数据失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 读取特征值的二进制数据操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * 向低功耗蓝牙设备指定特征值写入二进制数据 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ +interface PlusBluetoothWriteBLECharacteristicValueOptions { + /** + * 蓝牙设备的id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + deviceId?: string; + /** + * 蓝牙服务的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + serviceId?: string; + /** + * 蓝牙特征值的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + characteristicId?: string; + /** + * 要写入的数据 + * 写入到蓝牙设备指定特征值中的二进制值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + value?: ArrayBuffer; + /** + * 读取特征值的二进制数据成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + success?: (result: any) => void; + /** + * 读取特征值的二进制数据失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + fail?: (result: any) => void; + /** + * 读取特征值的二进制数据操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/bluetooth.html](http://www.html5plus.org/doc/zh_cn/bluetooth.html) + */ + complete?: (result: any) => void; +} + +/** + * Camera模块管理设备的摄像头，可用于拍照、摄像操作，通过plus.camera获取摄像头管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ +interface PlusCamera { + /** + * 摄像头对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + Camera?: PlusCameraCamera; + /** + * JSON对象，调用摄像头的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + CameraOptions?: PlusCameraCameraOptions; + /** + * 裁剪图片设置项 + *

+ * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + CameraCropStyles?: PlusCameraCameraCropStyles; + /** + * JSON对象，弹出拍照或摄像界面指示位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + PopPosition?: PlusCameraPopPosition; + /** + * 获取摄像头管理对象 + * 获取需要操作的摄像头对象，如果要进行拍照或摄像操作，需先通过此方法获取摄像头对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + getCamera(index?: number): PlusCameraCamera; +} + +/** + * 摄像头对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ +interface PlusCameraCamera { + /** + * 字符串数组，摄像头支持的拍照分辨率 + * 属性类型为String[]，若不支持此属性则返回空数组对象。 + * 摄像头支持的拍照图片分辨率字符串形式“WIDTH*Height”，如“400*800”；如果支持任意自定义分辨率则“*”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + supportedImageResolutions?: any []; + /** + * 字符串数组，摄像头支持的摄像分辨率 + * 属性类型为String[]，若不支持此属性则返回空数组对象。 + * 摄像头支持的视频分辨率字符串形式为“WIDTH*Height”，如“400*800”；如果支持任意自定义分辨率则“*”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + supportedVideoResolutions?: any []; + /** + * 字符串数组，摄像头支持的拍照文件格式 + * 属性类型为String[]，若不支持此属性则返回空数组对象。 + * 摄像头支持的图片文件格式字符串形式为文件格式后缀名，如“jpg”、“png”、“bmp”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + supportedImageFormats?: any []; + /** + * 字符串数组，摄像头支持的摄像文件格式 + * 属性类型为String[]，若不支持此属性则返回空数组对象。 + * 摄像头支持的视频文件格式字符串形式为文件格式后缀名，如“3gp”、“mp4”、“avi”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + supportedVideoFormats?: any []; + /** + * 进行拍照操作 + * 摄像头资源为独占资源，如果其它程序或页面已经占用摄像头，再次操作则失败。 + * 拍照操作成功将通过successCB返回拍照获取的图片路径。 + * 可通过option设置摄像头的各种属性参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + captureImage(successCB: (result: string) => void, errorCB?: (result: any) => void, options?: PlusCameraCameraOptions): void; + /** + * 调用摄像头进行摄像操作 + * 摄像头资源为独占资源，如果其它程序或页面已经占用摄像头，再次操作则失败。 + * 拍照操作成功将通过successCB返回摄像获取的视频文件路径。 + * 可通过option设置摄像头的各种属性参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + startVideoCapture(successCB: (result: string) => void, errorCB?: (result: any) => void, option?: PlusCameraCameraOptions): void; + /** + * 结束摄像操作 + * 开始调用摄像头进行摄像操作后，可在后台结束摄像操作，与用户在界面结束操作效果一致。 + * 摄像操作成功将通过startVideoCapture函数中的successCB返回拍照获取的图片路径。 + * 用户如果没有进行摄像操作关闭摄像头页面则调用失败回调函数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + stopVideoCapture(): void; +} + +/** + * JSON对象，调用摄像头的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ +interface PlusCameraCameraOptions { + /** + * 配置裁剪图片 + *

+ * 设置裁剪图片项后，在拍照后会进入裁剪编辑界面，确认后返回裁剪后的图片。 + * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + crop?: PlusCameraCameraCropStyles; + /** + * 拍照或摄像文件保存的路径 + * 可设置具体文件名（如"_doc/camera/a.jpg"）；也可只设置路径，以"/"结尾则表明是路径（如"_doc/camera/"）。 + * 如未设置文件名称或设置的文件名冲突则文件名由程序程序自动生成。 + * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + filename?: string; + /** + * 拍照或摄像的文件格式 + * 可通过Camera对象的supportedImageFormats或supportedVideoFormats获取，如果设置的参数无效则使用系统默认值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + format?: string; + /** + * 拍照或摄像默认使用的摄像头 + * 拍照或摄像界面默认使用的摄像头编号，1表示主摄像头，2表示辅摄像头。 + * - 1: 使用设备主摄像头 + * - 2: 使用设备辅摄像头 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + index?: '1' | '2'; + /** + * 视频长度 + * 单位为秒（s），小于等于0表示不限定视频长度。 + * 默认值为0（不限定视频长度）。 + * 注意：仅在调用拍摄视频（startVideoCapture）时有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + videoMaximumDuration?: number; + /** + * 是否优化图片 + * 自动调整图片的方向，在部分设备上可能出现图片方向不正确的问题，此参数将配置是否自动调整图片方向。 + * 可取值： + * true - 自动调整图片方向； + * false - 不调整。 + * 默认值为true。 + * 注意：自动调整图片方向将消耗部分系统资源，可能会导致拍照后回调触发时机延迟，将此值设置为false则可避免延迟问题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + optimize?: boolean; + /** + * 拍照或摄像使用的分辨率 + * 可通过Camera对象的supportedImageResolutions或supportedVideoResolutions获取，如果设置的参数无效则使用系统默认值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + resolution?: string; + /** + * 拍照或摄像界面弹出指示区域 + * 对于大屏幕设备如iPad，拍照或摄像界面为弹出窗口，此时可通过此参数设置弹出窗口位置，其为JSON对象，格式如{top:"10px",left:"10px",width:"200px",height:"200px"}，默认弹出位置为屏幕居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + popover?: PlusCameraPopPosition; +} + +/** + * 裁剪图片设置项 + *

+ * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ +interface PlusCameraCameraCropStyles { + /** + * 裁剪后保存图片的质量 + *

+ * 取值范围为1-100，数值越小，质量越低（仅对jpg格式有效）。 + * 默认值为80。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + quality?: number; + /** + * 裁剪的宽度 + *

+ * 单位为px，用于计算裁剪宽高比。 + * 必须设置此值。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + width?: number; + /** + * 裁剪的高度 + *

+ * 单位为px，用于计算裁剪宽高比。 + * 必须设置此值。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + height?: number; + /** + * 是否将图片保存为指定的宽高像素 + *

+ * true表示将width和height作为裁剪保存图片的像素值，false表示使用图片编辑操作的真实像素值。 + * 默认值为true。 + * 设置为false时在裁剪编辑界面显示图片的像素值，设置为true时不显示。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + resize?: boolean; +} + +/** + * JSON对象，弹出拍照或摄像界面指示位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ +interface PlusCameraPopPosition { + /** + * 指示区域距离容器顶部的距离 + * 弹出拍照或摄像窗口指示区域距离容器顶部的距离，支持像素值（如"100px"）和百分比（如"50%"）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + top?: string; + /** + * 指示区域距离容器左侧的距离 + * 弹出拍照或摄像窗口指示区域距离容器左侧的距离，支持像素值（如"100px"）和百分比（如"50%"）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + left?: string; + /** + * 指示区域的宽度 + * 弹出拍照或摄像窗口指示区域的宽度，支持像素值（如"100px"）和百分比（如"50%"）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + width?: string; + /** + * 指示区域的高度 + * 弹出拍照或摄像窗口指示区域的高度，支持像素值（如"100px"）和百分比（如"50%"）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/camera.html](http://www.html5plus.org/doc/zh_cn/camera.html) + */ + height?: string; +} + +/** + * Contacts模块管理系统通讯录，用于可对系统通讯录进行增、删、改、查等操作。通过plus.contacts获取系统通讯录管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContacts { + /** + * 通讯录对象 + * 通讯录管理对象，可对系统通讯录进行联系人的增、删、改、查操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + AddressBook?: PlusContactsAddressBook; + /** + * 联系人对象 + * 联系人对象，包括联系人的各种信息，如名称、电话号码、地址等。也包括新增、删除联系人的操作方法。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + Contact?: PlusContactsContact; + /** + * JSON对象，联系人域数据对象 + * 联系人域数据对象，保存联系人特定域信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ContactField?: PlusContactsContactField; + /** + * JSON对象，联系人名称对象 + * 联系人名称对象，保存联系人名称信息，如姓、名等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ContactName?: PlusContactsContactName; + /** + * JSON对象，联系人地址对象 + * 联系人地址对象，保存联系人地址信息，如国家、省份、城市等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ContactAddress?: PlusContactsContactAddress; + /** + * JSON对象，联系人所属组织信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ContactOrganization?: PlusContactsContactOrganization; + /** + * JSON对象，查找联系人参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ContactFindOption?: PlusContactsContactFindOption; + /** + * JSON对象，联系人查找过滤器 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ContactFindFilter?: PlusContactsContactFindFilter; + /** + * 手机通讯录 + * 通讯录类型常量，数值类型，固定值为0，用于获取系统的联系人信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ADDRESSBOOK_PHONE?: number; + /** + * SIM卡通讯录 + * 通讯录类型常量，数值类型，固定值为1，用于获取SIM卡上的联系人信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ADDRESSBOOK_SIM?: number; + /** + * 获取通讯录对象 + * 根据指定通讯录类型获取通讯录对象，获取通讯录对象后可对其进行增、删、改操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + getAddressBook(type: PlusContacts['ADDRESSBOOK_PHONE'] | PlusContacts['ADDRESSBOOK_SIM'], successCB: (result: PlusContactsAddressBook) => void, errorCB?: (result: any) => void): void; +} + +/** + * 通讯录对象 + * 通讯录管理对象，可对系统通讯录进行联系人的增、删、改、查操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsAddressBook { + /** + * 创建联系人 + * 创建一个系统联系人，并返回联系人对象，可对联系人对象进行操作设置联系人信息，如名称、地址、电话等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + create(): PlusContactsContact; + /** + * 在通讯录中查找联系人 + * 在通讯录中安装指定的规则查找联系人，contactFields可设定查找返回的联系人中包含的字段值，查找联系人成功时通过successCB回调返回，查找联系人失败则通过errorCB回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + find(contactFields: string [], successCB: (result: PlusContactsContact) => void, errorCB?: (result: any) => void, findOptions?: PlusContactsContactFindOption): void; +} + +/** + * 联系人对象 + * 联系人对象，包括联系人的各种信息，如名称、电话号码、地址等。也包括新增、删除联系人的操作方法。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContact { + /** + * 联系人的id + * 联系人id由系统分配维护，从系统获取联系人时自动赋值，再次查询时可使用此id值进行检索。 + * 注意：此值为只读属性，改写此值可能会导致无法预期的错误。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + id?: string; + /** + * 联系人显示的名字 + * 联系人显示的名字通常由其姓和名组合而成。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + displayName?: string; + /** + * 联系人的名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + name?: PlusContactsContactName; + /** + * 联系人的昵称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + nickname?: string; + /** + * 数组，联系人的电话 + * 如果联系人中未保存电话信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + phoneNumbers?: PlusContactsContactField; + /** + * 数组，联系人的邮箱 + * 如果联系人中未保存邮箱信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + emails?: PlusContactsContactField; + /** + * 数组，联系人的地址 + * 如果联系人中未保存地址信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + addresses?: PlusContactsContactAddress; + /** + * 数组，联系人的即时通讯地址 + * 如果联系人中未保存即时通讯地址信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + ims?: PlusContactsContactField; + /** + * 数组，联系人所属组织信息 + * 如果联系人中未保存所属组织信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + organizations?: PlusContactsContactOrganization; + /** + * 联系人的生日 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + birthday?: Date; + /** + * 联系人的备注 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + note?: string; + /** + * 数组，联系人的头像 + * 其值为头像图片url地址或图片数据： + * url地址：仅支持本地图片地址，可以是绝对路径或相对路径，如“_doc/a.png”； + * 图片数据：必须符合Data URI scheme（RFC2397）格式的数据，如“image/png;base64,XXXX”，其中XXXX为base64编码的图片数据。在获取联系人时默认返回此类型的数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + photos?: PlusContactsContactField; + /** + * 数组，联系人的组名 + * 如果联系人中未保存组名信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + categories?: PlusContactsContactField; + /** + * 数组，联系人的网址 + * 如果联系人中未保存网址信息，则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + urls?: PlusContactsContactField; + /** + * 克隆联系人 + * 克隆联系人，创建出一个新的联系人对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + clone(): PlusContactsContact; + /** + * 删除联系人 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + remove(successCB: () => void, errorCB?: (result: any) => void): void; + /** + * 保存联系人 + * 将联系人数据保存到通讯录中，操作成功将通过successCB回调函数返回保存结果，操作失败将通过通过errorCB回调函数返回错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + save(successCB: () => void, errorCB?: (result: any) => void): void; +} + +/** + * JSON对象，联系人域数据对象 + * 联系人域数据对象，保存联系人特定域信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContactField { + /** + * 联系人域类型，如电话号码中的“mobile”、“home”、“company” + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + type?: string; + /** + * 联系人域值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + value?: string; + /** + * 是否为首选项 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + preferred?: boolean; +} + +/** + * JSON对象，联系人名称对象 + * 联系人名称对象，保存联系人名称信息，如姓、名等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContactName { + /** + * 联系人的完整名称，由其它字段组合生成 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + formatted?: string; + /** + * 联系人的姓 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + familyName?: string; + /** + * 联系人的名 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + givenName?: string; + /** + * 联系人的中间名 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + middleName?: string; + /** + * 联系人的前缀（如Mr.或Dr.） + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + honorificPrefix?: string; + /** + * 联系人的后缀 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + honorificSuffix?: string; +} + +/** + * JSON对象，联系人地址对象 + * 联系人地址对象，保存联系人地址信息，如国家、省份、城市等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContactAddress { + /** + * 联系人地址类型，如“home”表示家庭地址、“company”表示单位地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + type?: string; + /** + * 完整地址，由其它字段组合而成 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + formatted?: string; + /** + * 完整的街道地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + streetAddress?: string; + /** + * 城市或地区 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + locality?: string; + /** + * 省或地区 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + region?: string; + /** + * 国家 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + country?: string; + /** + * 邮政编码 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + postalCode?: string; + /** + * 是否为首选项 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + preferred?: boolean; +} + +/** + * JSON对象，联系人所属组织信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContactOrganization { + /** + * 联系人所属组织类型，如"company" + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + type?: string; + /** + * 联系人所属组织名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + name?: string; + /** + * 联系人所属组织部门 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + department?: string; + /** + * 联系人在组织中的职位 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + title?: string; + /** + * 是否为首选项 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + preferred?: boolean; +} + +/** + * JSON对象，查找联系人参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContactFindOption { + /** + * 数组，查找时的过滤器 + * 可设置为空，表示不过滤。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + filter?: PlusContactsContactFindFilter; + /** + * 是否查找多个联系人，默认值为true + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + multiple?: boolean; +} + +/** + * JSON对象，联系人查找过滤器 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ +interface PlusContactsContactFindFilter { + /** + * 区配的逻辑 + * 可取“and”、“or”、“not”，默认值为“and”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + logic?: string; + /** + * 区配的联系人域，可取联系人的属性名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + field?: string; + /** + * 区配的联系人值，可使用区配符号“?”和“*” + * + * 参考: [http://www.html5plus.org/doc/zh_cn/contacts.html](http://www.html5plus.org/doc/zh_cn/contacts.html) + */ + value?: string; +} + +/** + * Device模块管理设备信息，用于获取手机设备的相关信息，如IMEI、IMSI、型号、厂商等。通过plus.device获取设备信息管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDevice { + /** + * 设备信息对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + DeviceInfo?: PlusDeviceDeviceInfo; + /** + * 设备的国际移动设备身份码 + *

+ * 此API将废弃，HBuilderX2.0.0以后版本使用plus.device.getInfo。 + * 调用此属性获取设备的国际移动设备身份码。 + * 如果设备不支持则返回空字符串。 + * 如果设备存在多个身份码，则以“,”字符分割拼接，如“862470039452950,862470039452943”。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + imei?: string; + /** + * 设备的国际移动用户识别码 + *

+ * 此API将废弃，HBuilderX2.0.0以后版本使用plus.device.getInfo。 + * 字符串数组类型，获取设备上插入SIM的国际移动设备身份码。 + * 如果设备支持多卡模式则返回所有SIM身份码。 + * 如果设备不支持或没有插入SIM卡则返回空数组。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + imsi?: string []; + /** + * 设备的型号 + * 调用此属性获取设备的型号信息。 + * 如果设备不支持则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + model?: string; + /** + * 设备的生产厂商 + * 调用此属性获取设备的生产厂商信息。 + * 如果设备不支持则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + vendor?: string; + /** + * 设备的唯一标识 + *

+ * 此API将废弃，HBuilderX2.0.0以后版本使用plus.device.getInfo。 + * 调用此属性获取设备的唯一标识号。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + uuid?: string; + /** + * 获取设备信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getInfoOptions?: PlusDeviceGetInfoOptions; + /** + * 获取匿名设备标识符 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getOAIDOptions?: PlusDeviceGetOAIDOptions; + /** + * 获取开发者匿名设备标识符 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getVAIDOptions?: PlusDeviceGetVAIDOptions; + /** + * 获取应用匿名设备标识符 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getAAIDOptions?: PlusDeviceGetAAIDOptions; + /** + * 发出蜂鸣声 + * 调用此方法使得设备发出蜂鸣声。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + beep(times?: number): void; + /** + * 拨打电话 + * 调用系统程序拨打电话。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + dial(number: string, confirm?: boolean): void; + /** + * 获取设备信息 + *

+ * 包括国际移动设备身份码、国际移动用户识别码、设备的唯一标识等信息。 + * 使用此方法可避免Android平台在应用启动时弹出访问设备信息、拨打电话等权限提示框的问题，详情参考https://ask.dcloud.net.cn/article/36075。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getInfo(options: PlusDeviceGetInfoOptions): void; + /** + * 获取匿名设备标识符 + *

+ * HBuilderX2.4.0+版本新增支持。 + * Android10以前获取设备标识（如IMEI、IMSI、Wi-Fi MAC地址等）涉及用户隐私且需用户授权，Android10+系统不再支持获取设备标识信息。为解决此问题移动安全联盟联合各手机厂商推出移动智能设备标识公共服务平台提供补充设备标识体系，包括匿名设备标识符（OAID）、开发者匿名设备标识符（VAID）和应用匿名设备标识符（AAID）。 + * 匿名设备标识符（OAID）最长为64位字符串，所有应用获取的值相同，可用于个性化推荐、广告等业务。 + * 系统首次启动后生成，用户手动重置、恢复出厂设置、设备商重置、被刷机等操作会重置此标识。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getOAID(options: PlusDeviceGetOAIDOptions): void; + /** + * 获取开发者匿名设备标识符 + *

+ * HBuilderX2.4.0+版本新增支持。 + * Android10以前获取设备标识（如IMEI、IMSI、Wi-Fi MAC地址等）涉及用户隐私且需用户授权，Android10+系统不再支持获取设备标识信息。为解决此问题移动安全联盟联合各手机厂商推出移动智能设备标识公共服务平台提供补充设备标识体系，包括匿名设备标识符（OAID）、开发者匿名设备标识符（VAID）和应用匿名设备标识符（AAID）。 + * 开发者匿名设备标识符（VAID）最长为64位字符串，同一开发者不同应用获取的值相同，可用于同一开发者不同应用之间的推荐等。 + * 在应用安装时生成，用户恢复出厂设置、卸载所有开发商应用、设备商重置、被刷机等操作会重置此标识。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getVAID(options: PlusDeviceGetVAIDOptions): void; + /** + * 获取应用匿名设备标识符 + *

+ * HBuilderX2.4.0+版本新增支持。 + * Android10以前获取设备标识（如IMEI、IMSI、Wi-Fi MAC地址等）涉及用户隐私且需用户授权，Android10+系统不再支持获取设备标识信息。为解决此问题移动安全联盟联合各手机厂商推出移动智能设备标识公共服务平台提供补充设备标识体系，包括匿名设备标识符（OAID）、开发者匿名设备标识符（VAID）和应用匿名设备标识符（AAID）。 + * 应用匿名设备标识符（AAID）最长为64位字符串，每个应用获取的值都不相同，可用于用户统计等。 + * 在应用安装时生成，用户恢复出厂设置、卸载应用、清空应用数据、设备商重置等操作会重置此标识。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getAAID(options: PlusDeviceGetAAIDOptions): void; + /** + * 获取设备的系统音量 + * 系统音量值范围为0到1，0表示静音，1表示最大音量值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getVolume(): number; + /** + * 获取程序是否一直保持唤醒（屏幕常亮）状态 + * 调用此方法获取程序是否一致保持唤醒状态。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + isWakelock(): boolean; + /** + * 设置应用是否保持唤醒（屏幕常亮）状态 + * 调用此方法设置应用是否一直保持唤醒状态，保持唤醒状态将会导致程序屏幕常亮、系统不会自动锁屏，从而导致消耗更多的电量。若未设置一直保持唤醒状态则会根据系统设置自动锁定屏幕。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + setWakelock(lock: boolean): void; + /** + * 设置设备的系统音量 + * 调用此方法调节设备的系统音量。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + setVolume(volume: number): void; + /** + * 设备振动 + * 调用此方法使得设备振动。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + vibrate(milliseconds: number): void; +} + +/** + * 设备信息对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDeviceDeviceInfo { + /** + * 设备的国际移动设备身份码 + * 如果设备不支持或无法获取（如用户未授权）则返回空字符串。 + * 如果设备存在多个身份码，则以“,”字符分割拼接，如“862470039452950,862470039452943”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + imei?: string; + /** + * 设备的国际移动用户识别码 + * 字符串数组类型，获取设备上插入SIM的国际移动设备身份码。 + * 如果设备支持多卡模式则返回所有SIM身份码。 + * 如果设备不支持或没有插入SIM卡则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + imsi?: string []; + /** + * 设备标识 + * 设备的唯一标识号。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + uuid?: string; +} + +/** + * Screen模块管理设备屏幕信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusScreen { + /** + * 设备屏幕水平方向的密度 + * 设备屏幕的密度为每英寸所显示的像素点数，密度越高显示清晰度越高，单位为dpi。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + dpiX?: number; + /** + * 设备屏幕垂直方向的密度 + * 设备屏幕的密度为每英寸所显示的像素点数，密度越高显示清晰度越高，单位为dpi。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + dpiY?: number; + /** + * 屏幕高度物理分辨率 + * 单位为px，设备屏幕的实际物理分辨率。 + * 物理分辨率跟屏幕密度相关，通常建议使用逻辑分辨率。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + height?: number; + /** + * 屏幕宽度物理分辨率 + * 单位为px，设备屏幕的实际物理分辨率。 + * 物理分辨率跟屏幕密度相关，通常建议使用逻辑分辨率。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + width?: number; + /** + * 屏幕高度逻辑分辨率 + * 单位为px, 逻辑分辨率为物理分辨率除以缩放比例scale取整。 + * 取整操作可能出现精度丢失，对精度要求高时可使用物理分辨率和scal计算。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + resolutionHeight?: number; + /** + * 屏幕宽度逻辑分辨率 + * 单位为px，逻辑分辨率为物理分辨率除以缩放比例scale取整。 + * 取整操作可能出现精度丢失，对精度要求高时可使用物理分辨率和scal计算。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + resolutionWidth?: number; + /** + * 逻辑分辨率与物理分辨率的缩放比例 + * 由于设备屏幕密度不同，在html页面中使用的像素值都是使用逻辑分辨率。 + * 而逻辑分辨率与设备的实际物理分辨率存在一定的比例关系，实际物理分辨率=逻辑分辨率*比例。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + scale?: number; + /** + * 设置屏幕亮度 + * 调用此方法调节设备屏幕亮度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + setBrightness(brightness: number): void; + /** + * 获取屏幕亮度值 + * 屏幕亮度值范围为0到1，0表示最低亮度值，1表示最高亮度值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getBrightness(): number; + /** + * 获取当前屏幕信息 + *

+ * 当前屏幕的宽、高信息，返回数据包括以下属性： + *

    + *
  • "height" - 屏幕物理分辨率高度，单位为px
    • + *
  • "width" - 屏幕物理分辨率宽度，单位为px
    • + *
  • "resolutionHeight" - 屏幕逻辑分辨率高度，单位为px
    • + *
  • "resolutionWidth" - 屏幕逻辑分辨率宽度，单位为px
    • + *
+ * 注意：HBuilderX2.6.9+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getCurrentSize(): any; + /** + * 锁定屏幕方向 + * 锁定屏幕方向后屏幕只能按锁定的屏幕方向显示，关闭当前页面后仍然有效。 + * 可再次调用此方法修改屏幕锁定方向或调用unlockOrientation()方法恢复到应用的默认值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + lockOrientation(orientation: 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary' | 'portrait' | 'landscape'): void; + /** + * 解除锁定屏幕方向 + * 解除锁定屏幕方向后将恢复应用默认的屏幕显示方向（通常为应用打包发布时设置的方向）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + unlockOrientation(): void; +} + +/** + * Display模块管理应用可使用的显示区域信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDisplay { + /** + * 应用可使用的屏幕高度逻辑分辨率 + * 设备屏幕区域包括系统状态栏显示区域和应用显示区域，display获取的是应用显示区域的逻辑分辨率，单位为px。 + * 如果需要获取实际分辨率则需要乘以比例值scale。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + resolutionHeight?: number; + /** + * 应用可使用的屏幕宽度逻辑分辨率 + * 设备屏幕区域包括系统状态栏显示区域和应用显示区域，display获取的是应用显示区域的逻辑分辨率，单位为px。 + * 如果需要获取实际分辨率则需要乘以比例值scale。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + resolutionWidth?: number; +} + +/** + * networkinfo模块用于获取网络信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusNetworkinfo { + /** + * 网络连接状态未知 + * 网络状态常量，表示当前设备网络状态未知，固定值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_UNKNOW?: number; + /** + * 未连接网络 + * 网络状态常量，当前设备网络未连接网络，固定值为1。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_NONE?: number; + /** + * 有线网络 + * 网络状态常量，当前设备连接到有线网络，固定值为2。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_ETHERNET?: number; + /** + * 无线WIFI网络 + * 网络状态常量，当前设备连接到无线WIFI网络，固定值为3。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_WIFI?: number; + /** + * 蜂窝移动2G网络 + * 网络状态常量，当前设备连接到蜂窝移动2G网络，固定值为4。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_CELL2G?: number; + /** + * 蜂窝移动3G网络 + * 网络状态常量，当前设备连接到蜂窝移动3G网络，固定值为5。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_CELL3G?: number; + /** + * 蜂窝移动4G网络 + * 网络状态常量，当前设备连接到蜂窝移动4G网络，固定值为6。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_CELL4G?: number; + /** + * 蜂窝移动5G网络 + * 网络状态常量，当前设备连接到蜂窝移动5G网络，固定值为7。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + CONNECTION_CELL5G?: number; + /** + * 获取设备当前连接的网络类型 + * 获取当前设备连接的网络类型，返回值为网络类型常量，可取值CONNECTION_*常量。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + getCurrentType(): number; + /** + * 获取当前网络是否设置代理 + * 注意：HBuilderX3.0.0及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + isSetProxy(): boolean; +} + +/** + * OS模块管理操作系统信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusOs { + /** + * 系统语言信息 + * 获取当前操作系统设置的系统语言，字符串类型数据，格式为"语言-地区"，如"zh-CN"表示语言为简体中文、地区为中国大陆。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + language?: string; + /** + * 系统的名称 + * 获取当前操作系统的名称，字符串类型数据。 + * - iOS: + * iOS系统。 + * + * - Android: + * Android系统。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + name?: 'iOS' | 'Android'; + /** + * 系统的供应商信息 + * 获取当前操作系统的供应商名称，字符串类型数据。 + * - Apple: + * iOS设备，包括iPhone、iPad、iTouch。 + * + * - Google: + * Android设备。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + vendor?: 'Apple' | 'Google'; + /** + * 系统版本信息 + * 获取当前操作系统的版本信息，字符串类型数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + version?: string; +} + +/** + * 获取设备信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDeviceGetInfoOptions { + /** + * 获取设备信息成功回调函数 + *

+ * 回调函数参数event对象类型为DeviceInfo。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + success?: (result: any) => void; + /** + * 获取设备信息失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + fail?: (result: any) => void; + /** + * 获取设备信息操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取匿名设备标识符 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDeviceGetOAIDOptions { + /** + * 获取匿名设备标识成功回调函数 + *

+ * 回调函数参数event对象类型为json，包含oaid属性保存获取的匿名设备标识符。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + success?: (result: any) => void; + /** + * 获取匿名设备标识失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + fail?: (result: any) => void; + /** + * 获取匿名设备标识操作完成回调函数 + * 调用成功或失败都会触发此回调，成功时回调参数与DeviceSuccessCallback一致，失败时回调参数与DeviceCompleteCallback一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取开发者匿名设备标识符 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDeviceGetVAIDOptions { + /** + * 获取开发者匿名设备标识成功回调函数 + *

+ * 回调函数参数event对象类型为json，包含vaid属性保存获取的开发者匿名设备标识符。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + success?: (result: any) => void; + /** + * 获取开发者匿名设备标识失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + fail?: (result: any) => void; + /** + * 获取开发者匿名设备标识操作完成回调函数 + * 调用成功或失败都会触发此回调，成功时回调参数与DeviceSuccessCallback一致，失败时回调参数与DeviceCompleteCallback一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取应用匿名设备标识符 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ +interface PlusDeviceGetAAIDOptions { + /** + * 获取应用匿名设备标识成功回调函数 + *

+ * 回调函数参数event对象类型为json，包含aaid属性保存获取的应用匿名设备标识符。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + success?: (result: any) => void; + /** + * 获取应用匿名设备标识失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + fail?: (result: any) => void; + /** + * 获取应用匿名设备标识操作完成回调函数 + * 调用成功或失败都会触发此回调，成功时回调参数与DeviceSuccessCallback一致，失败时回调参数与DeviceCompleteCallback一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/device.html](http://www.html5plus.org/doc/zh_cn/device.html) + */ + complete?: (result: any) => void; +} + +/** + * Downloader模块管理网络文件下载任务，用于从服务器下载各种文件，并支持跨域访问操作。通过plus.downloader获取下载管理对象。Downloader下载使用HTTP的GET/POST方式请求下载文件，符合标准HTTP/HTTPS传输协议。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ +interface PlusDownloader { + /** + * Download对象管理一个下载任务 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + Download?: PlusDownloaderDownload; + /** + * 下载任务事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + DownloadEvent?: PlusDownloaderDownloadEvent; + /** + * 下载任务状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + DownloadState?: PlusDownloaderDownloadState; + /** + * 下载任务参数 + * 在创建下载任务时设置的参数，如设置下载任务使用的HTTP协议类型、优先级等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + DownloadOptions?: PlusDownloaderDownloadOptions; + /** + * 新建下载任务 + * 请求下载管理创建新的下载任务，创建成功则返回Download对象，用于管理下载任务。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + createDownload(url: string, options?: PlusDownloaderDownloadOptions, completedCB?: (result0: PlusDownloaderDownload, result1: number) => void): PlusDownloaderDownload; + /** + * 枚举下载任务 + * 枚举指定状态的下载任务列表，通过enumCB回调函数返回结果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + enumerate(enumCB: (result: PlusDownloaderDownload []) => void, state?: '0' | '1' | '2' | '3' | '4' | '5' | '-1'): void; + /** + * 清除下载任务 + * 清除指定状态的下载任务。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + clear(state?: '0' | '1' | '2' | '3' | '4' | '5' | '-1'): void; + /** + * 开始所有下载任务 + * 开始所有处于为开始调度或暂停状态的下载任务。 + * 若下载任务数超过可并发处理的总数，超出的任务处于调度状态（等待下载），当有任务完成时根据调度状态任务的优先级选择任务开始下载。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + startAll(): void; +} + +/** + * Download对象管理一个下载任务 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ +interface PlusDownloaderDownload { + /** + * 下载任务的标识 + * 在创建任务时系统自动分配，用于标识下载任务的唯一性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + id?: string; + /** + * 下载文件的地址 + * 调用plus.donwloader.createDownload()方法创建下载任务时设置的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + url?: string; + /** + * 任务的状态 + * 表示当前下载任务的状态，可通过addEventListener()方法监听statechanged事件监听任务状态的变化。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + state?: PlusDownloaderDownloadState; + /** + * 下载任务的参数 + * 调用plus.donwloader.createDownload()方法创建下载任务时设置的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + options?: PlusDownloaderDownloadOptions; + /** + * 下载的文件名称 + * 下载任务在本地保存的文件路径，下载任务完成时更新，可通过此值访问下载的文件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + filename?: string; + /** + * 已完成下载文件的大小 + * 整数类型，单位为字节（byte），下载任务开始传输数据时，每次触发statechanged事件或下载任务完成时更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + downloadedSize?: number; + /** + * 下载任务文件的总大小 + * 整数类型，单位为字节（byte），下载任务开始传输数据时更新，在此之前其值为0。 + * 此值是从HTTP协议的Content-Length中获取，如果服务器未返回Content-Length数据则此值始终为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + totalSize?: number; + /** + * 取消下载任务 + * 如果任务未完成，则终止下载，并从任务列表中删除。 + * 如下载未完成，将删除已下载的临时文件，如果下载已完成，将不删除已下载的文件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + abort(): void; + /** + * 添加下载任务事件监听器 + * 下载任务添加事件监听器后，当监听的事件发生时触发listener回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + addEventListener(type: 'statechanged', listener?: (result0: PlusDownloaderDownload, result1: number) => void, capture?: boolean): void; + /** + * 获取下载请求HTTP响应头部信息 + * HTTP响应头部全部内容作为未解析的字符串返回，如果没有接收到这个HTTP响应头数据或者下载请求未完成则为空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + getAllResponseHeaders(): string; + /** + * 获取下载请求指定的HTTP响应头部的值 + * 其参数是要返回的HTTP响应头部的名称，可以使用任何大小写来制定这个头部名字，和响应头部的比较是不区分大小写的。 + * 如果没有接收到这个头部或者下载请求未完成则为空字符串；如果接收到多个有指定名称的头部，这个头部的值被连接起来并返回，使用逗号和空格分隔开各个头部的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + getResponseHeader(headerName?: string): string; + /** + * 暂停下载任务 + * 暂停下载任务，如果任务已经处于初始状态或暂停状态则无任何响应。 + * 通常在任务已开始后暂停任务。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + pause(): void; + /** + * 恢复暂停的下载任务 + * 继续暂停的下载任务，如果任务处于非暂停状态则无任何响应。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + resume(): void; + /** + * 设置下载请求的HTTP头数据 + * Http的Header应该包含在通过后续start()调用而发起的请求中，此方法必需在调用start()之前设置才能生效。 + * 如果带有指定名称的头部已经被指定了，这个头部的新值就是：之前指定的值，加上逗号、以及这个调用指定的值（形成一个数组）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + setRequestHeader(headerName: string, headerValue: string): void; + /** + * 开始下载任务 + * 开始下载任务，如果任务已经处于开始状态则无任何响应。 + * 在创建任务或任务下载失败后调用可重新开始下载。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + start(): void; +} + +/** + * 下载任务事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ +interface PlusDownloaderDownloadEvent { + /** + * 下载任务状态变化事件 + * 当下载任务状态发生变化时触发此事件，事件原型参考DownloadStateChangedCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + statechanged?: string; +} + +/** + * 下载任务状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ +type PlusDownloaderDownloadState = undefined | 0 | 1 | 2 | 3 | 4 | 5 | -1; + +/** + * 下载任务参数 + * 在创建下载任务时设置的参数，如设置下载任务使用的HTTP协议类型、优先级等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ +interface PlusDownloaderDownloadOptions { + /** + * 网络请求类型 + * 支持http协议的“GET”、“POST”，默认为“GET”请求。 + * - GET: GET请求 + * - POST: POST请求 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + method?: 'GET' | 'POST'; + /** + * POST请求时提交的数据 + * 仅在网络请求类型method设置为"POST"时有效，"GET"请求时忽略此数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + data?: string; + /** + * 下载文件保存的路径 + * 保存文件路径仅支持以"_downloads/"、"_doc/"、"_documents/"开头的字符串。 + * 文件路径以文件后缀名结尾（如"_doc/download/a.doc"）表明指定保存文件目录及名称，以“/”结尾则认为指定保存文件的目录（此时程序自动生成文件名）。 + * 如果指定的文件已经存在，则自动在文件名后面加"(i)"，其中i为数字，如果文件名称后面已经是此格式，则数字i递增，如"download(1).doc"。 + * 默认保存目录为（"_downloads"），并自动生成文件名称。 + * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + filename?: string; + /** + * 下载任务的优先级 + * 数值类型，数值越大优先级越高，默认优先级值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + priority?: number; + /** + * 下载任务超时时间 + * 数值类型，单位为s(秒)，默认值为120s。 + * 超时时间为服务器响应请求的时间（不是下载任务完成的总时间），如果设置为0则表示永远不超时。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + timeout?: number; + /** + * 下载任务重试次数 + * 数值类型，默认为重试3次。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + retry?: number; + /** + * 下载任务重试间隔时间 + * 数值类型，单位为s(秒)，默认值为30s。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/downloader.html](http://www.html5plus.org/doc/zh_cn/downloader.html) + */ + retryInterval?: number; +} + +/** + * Fingerprint模块管理指纹识别。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ +interface PlusFingerprint { + /** + * JSON对象，指纹识别认证参数 + * 用于设置指纹识别认证界面显示的提示信息等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + AuthenticateOptions?: PlusFingerprintAuthenticateOptions; + /** + * JSON对象，指纹识别错误信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + FingerprintError?: PlusFingerprintFingerprintError; + /** + * 当前设备环境是否支持指纹识别 + * 目前还有很多设备没有指纹识别模块，需要调用此方法判断是否可使用指纹识别功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + isSupport(): boolean; + /** + * 当前设备是否设置密码锁屏 + * 如果设备没有设置密码锁屏，则无法使用指纹识别功能，建议调用指纹识别前先使用此接口检查。 + * 调用plus.fingerprint.authenticate会返回失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + isKeyguardSecure(): boolean; + /** + * 当前设备是否已经录入指纹 + * 如果设备没有录入指纹，则无法使用指纹识别功能，建议调用指纹识别前先使用此接口检查。 + * 调用plus.fingerprint.authenticate会返回失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + isEnrolledFingerprints(): boolean; + /** + * 指纹识别认证 + * 用户可以开始输入指纹进行识别，如果认证成功则触发successCB回调，识别失败则触发errorCB回调返回错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + authenticate(successCB: () => void, errorCB: (result: PlusFingerprintFingerprintError) => void, options?: PlusFingerprintAuthenticateOptions): void; + /** + * 取消指纹识别认证 + * 取消当前正在处理的指纹识别认证操作。 + * 如果当前没有进行指纹识别则不进行任何操作；如果当前正在进行指纹识别则触发错误回调（错误码为“CANCEL”）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + cancel(): void; +} + +/** + * JSON对象，指纹识别认证参数 + * 用于设置指纹识别认证界面显示的提示信息等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ +interface PlusFingerprintAuthenticateOptions { + /** + * 在指纹识别过程中显示在界面上的提示信息 + * 如果指纹识别认证过程中不显示提示框，则不显示此信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + message?: string; +} + +/** + * JSON对象，指纹识别错误信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ +interface PlusFingerprintFingerprintError { + /** + * 不支持指纹识别 + * 当前设备不支持指纹识别功能时返回此错误，错误代码常量值为1。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + UNSUPPORT?: number; + /** + * 设备未设置密码锁屏 + * 当前设备为设置密码锁屏导致无法使用指纹识别功能时返回此错误，错误代码常量值为2。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + KEYGUARD_INSECURE?: number; + /** + * 未录入指纹识别 + * 当前设备未录入指纹导致无法使用指纹识别功能时返回此错误，错误代码常量值为3。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + FINGERPRINT_UNENROLLED?: number; + /** + * 指纹识别不匹配 + * 用户指纹识别认证不通过时返回此错误，错误代码常量值为4。 + * 用户每次尝试指纹识别认证未通过都会触发此错误，此时还可以继续识别认证。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + AUTHENTICATE_MISMATCH?: number; + /** + * 指纹识别次数超过限制 + * 用户多次指纹识别认证不通过时返回此错误，错误代码常量值为5。 + * 通常出现此错误后系统会锁定一段时间禁止使用指纹识别，如果再次调用指纹识别认证会立即返回此错误，因此出现此错误时应该提示用户使用其它方式进行认证。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + AUTHENTICATE_OVERLIMIT?: number; + /** + * 取消指纹识别 + * 用户取消指纹识别认证时返回此错误，错误代码常量值为6。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + CANCEL?: number; + /** + * 未知错误 + * 其它未知错误，错误代码常量值为7。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + UNKNOWN_ERROR?: number; + /** + * 错误代码 + * 取值范围为FingerprintError对象的错误常量值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + code?: number; + /** + * 错误描述信息 + * 详细错误描述信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/fingerprint.html](http://www.html5plus.org/doc/zh_cn/fingerprint.html) + */ + message?: string; +} + +/** + * Gallery模块管理系统相册，支持从相册中选择图片或视频文件、保存图片或视频文件到相册等功能。通过plus.gallery获取相册管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ +interface PlusGallery { + /** + * JSON对象，从相册中选择文件的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + GalleryOptions?: PlusGalleryGalleryOptions; + /** + * 裁剪图片设置项 + *

+ * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + GalleryCropStyles?: PlusGalleryGalleryCropStyles; + /** + * 相册选择文件过滤类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + GalleryFilter?: PlusGalleryGalleryFilter; + /** + * 保存图片到相册成功事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + GallerySaveEvent?: PlusGalleryGallerySaveEvent; + /** + * JSON对象，弹出拍照或摄像界面指示位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + PopPosition?: PlusGalleryPopPosition; + /** + * 从系统相册选择文件（图片或视频） + * 从系统相册中选择图片或视频文件。每次仅能选择一个文件，选择后将返回选择的文件路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + pick(succesCB: (result: string) => void, errorCB?: (result: any) => void, options?: PlusGalleryGalleryOptions): void; + /** + * 保存文件到系统相册中 + * 保存文件到系统相册中。 + * 每次仅能保存一个文件，支持图片文件（jpg/jpeg、png、bmp等格式）和视频文件（3gp、mov等格式）。 + * 若保存的文件类型当前系统不支持，则通过errorCB回调返回错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + save(path : string, succesCB: (result: PlusGalleryGallerySaveEvent) => void, errorCB?: (result: any) => void): void; +} + +/** + * JSON对象，从相册中选择文件的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ +interface PlusGalleryGalleryOptions { + /** + * 是否显示系统相册文件选择界面的动画 + * 可取值true、false，默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + animation?: boolean; + /** + * 确认按钮文字 + *

+ * 不传入此参数时，使用默认确认按钮文字“确定”。 + * 注意：HBuilderX3.1.5+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + confirmText?: string; + /** + * 配置裁剪图片 + *

+ * 设置裁剪图片项后，在相册中选择图片一定会进入裁剪编辑界面，确认后返回裁剪后的图片。 + * 设置此值后只能选择一张图片。 + * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + crop?: PlusGalleryGalleryCropStyles; + /** + * 是否支持编辑图片 + *

+ * 可取值true、false，默认值为true。 + * 注意：HBuilderX3.1.5+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + editable?: boolean; + /** + * 选择文件保存的路径 + * 某些系统不能直接使用系统相册的路径，这时需要将选择的文件保存到应用可访问的目录中，可通过此参数设置保存文件的路径。 + * 如果路径中包括文件后缀名称，则表明指定文件路径及名称，否则仅指定文件保存目录，文件名称自动生成。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + filename?: string; + /** + * 相册中选择文件类型过滤器 + * 系统相册选择器中可选择的文件类型，可设置为仅选择图片文件（“image”）、视频文件（“video”）或所有文件（“none”），默认值为“image”。 + * - image: 仅可选择图片文件 + * - video: 仅可选择视频文件 + * - none: 可选择图片或视频文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + filter?: 'image' | 'video' | 'none'; + /** + * 最多选择的图片数量 + * 仅在支持多选时有效，取值范围为1到Infinity，默认值为Infinity，即不限制选择的图片数。 + * 如果设置的值非法则使用默认值Infinity。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + maximum?: number; + /** + * 是否支持多选图片 + * 可从系统相册中选择多张图片，选择图片后通过GalleryMultiplePickSuccessCallback回调返回选择的图片。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + multiple?: boolean; + /** + * 超过最多选择图片数量事件 + * 使用相册多选图片时，可通过maximum属性设置最多选择的图片数量，当用户操作选择的数量大于此时触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + onmaxed?: () => void; + /** + * 是否检测权限 + *

+ * 可取值： + *

    + *
  • true - 检测到用户没有授权访问相册，将会弹出提示框引导用户授权
    • + *
  • false - 检测到用户没有授权访问相册，触发错误回调，无界面提示
    • + *
+ * 默认值为false。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + permissionAlert?: boolean; + /** + * 相册选择界面弹出指示区域 + * 对于大屏幕设备如iPad，相册选择界面为弹出窗口，此时可通过此参数设置弹出窗口位置。 + * 其为JSON对象，格式如{top:"10px",left:"10px",width:"200px",height:"200px"}，所有值为像素值，左上坐标相对于容器的位置，默认弹出位置为屏幕居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + popover?: PlusGalleryPopPosition; + /** + * 已选择的图片路径列表 + * 仅在多图片选择时生效，相册选择界面将选中指定的图片路径列表。 + * 如果指定的路径无效，则忽略此项；如果指定的路径数超过maximum属性指定的最大选择数目则超出的图片不选中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + selected?: string []; + /** + * 是否使用系统相册文件选择界面 + * 废弃，HBuilderX2.9.6+版本不再使用系统自带相册选择控件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + system?: boolean; +} + +/** + * 裁剪图片设置项 + *

+ * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ +interface PlusGalleryGalleryCropStyles { + /** + * 裁剪后保存图片的质量 + *

+ * 取值范围为1-100，数值越小，质量越低（仅对jpg格式有效）。 + * 默认值为80。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + quality?: number; + /** + * 裁剪的宽度 + *

+ * 单位为px，用于计算裁剪宽高比。 + * 必须设置此值。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + width?: number; + /** + * 裁剪的高度 + *

+ * 单位为px，用于计算裁剪宽高比。 + * 必须设置此值。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + height?: number; + /** + * 是否将图片保存为指定的宽高像素 + *

+ * true表示将width和height作为裁剪保存图片的像素值，false表示使用图片编辑操作的真实像素值。 + * 默认值为true。 + * 设置为false时在裁剪编辑界面显示图片的像素值，设置为true时不显示。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + resize?: boolean; +} + +/** + * 相册选择文件过滤类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ +interface PlusGalleryGalleryFilter { + /** + * 仅可选择图片文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + image?: string; + /** + * 仅可选择视频文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + video?: string; + /** + * 不过滤，可选择图片或视频文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + none?: string; +} + +/** + * 保存图片到相册成功事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ +interface PlusGalleryGallerySaveEvent { + /** + * 保存到相册的图片路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + path?: string; +} + +/** + * JSON对象，弹出拍照或摄像界面指示位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ +interface PlusGalleryPopPosition { + /** + * 指示区域距离容器顶部的距离 + * 弹出拍照或摄像窗口指示区域距离容器顶部的距离，单位支持像素值（如"100px"）和百分比（如"50%"），如不写单位则为像素值值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + top?: string; + /** + * 指示区域距离容器左侧的距离 + * 弹出拍照或摄像窗口指示区域距离容器左侧的距离，单位支持像素值（如"100px"）和百分比（如"50%"），如不写单位则为像素值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + left?: string; + /** + * 指示区域的宽度 + * 弹出拍照或摄像窗口指示区域的宽度，单位支持像素值（如"100px"）和百分比（如"50%"），如不写单位则为像素值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + width?: string; + /** + * 指示区域的高度 + * 弹出拍照或摄像窗口指示区域的高度，单位支持像素值（如"100px"）和百分比（如"50%"），如不写单位则为像素值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/gallery.html](http://www.html5plus.org/doc/zh_cn/gallery.html) + */ + height?: string; +} + +/** + * Geolocation模块管理设备位置信息，用于获取地理位置信息，如经度、纬度等。通过plus.geolocation可获取设备位置管理对象。虽然W3C已经提供标准API获取位置信息，但在某些平台存在差异或未实现，为了保持各平台的统一性，定义此规范接口获取位置信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ +interface PlusGeolocation { + /** + * JSON对象，设备位置信息数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + Position?: PlusGeolocationPosition; + /** + * JSON对象，地址信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + Address?: PlusGeolocationAddress; + /** + * JSON对象，地理坐标信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + Coordinates?: PlusGeolocationCoordinates; + /** + * JSON对象，监听设备位置信息参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + PositionOptions?: PlusGeolocationPositionOptions; + /** + * JSON对象，定位错误信息 + *

+ * 这里根据W3C规范定义了定位标准错误码，在此基础上5+ 扩展了错误码，参考 5+ API错误代码中的“Geolocation模块错误” + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + GeolocationError?: PlusGeolocationGeolocationError; + /** + * 获取当前设备位置信息 + * 位置信息将通过手机GPS设备或其它信息如IP地址、移动网络信号获取，由于获取位置信息可能需要较长的时间，当成功获取位置信息后将通过successCB回调函数返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + getCurrentPosition(successCB: (result: PlusGeolocationPosition) => void, errorCB?: (result: PlusGeolocationGeolocationError) => void, options?: PlusGeolocationPositionOptions): void; + /** + * 监听设备位置变化信息 + * 位置信息将通过手机GPS设备或其它信息如IP地址、移动网络信号获取。 + * 当位置信息更新后将通过successCB回调函数返回。 + * 位置信息获取失败则调用回调函数errorCB。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + watchPosition(successCB: (result: PlusGeolocationPosition) => void, errorCB?: (result: PlusGeolocationGeolocationError) => void, option?: PlusGeolocationPositionOptions): number; + /** + * 关闭监听设备位置信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + clearWatch(watchId: number): void; +} + +/** + * JSON对象，设备位置信息数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ +interface PlusGeolocationPosition { + /** + * 地理坐标信息，包括经纬度、海拔、速度等信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + coords?: PlusGeolocationCoordinates; + /** + * 获取到地理坐标信息的坐标系类型 + * 可取以下坐标系类型： + * "wgs84"：表示WGS-84坐标系； + * "gcj02"：表示国测局经纬度坐标系； + * "bd09"：表示百度墨卡托坐标系，仅百度定位支持； + * "bd09ll"：表示百度经纬度坐标系，仅百度定位支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + coordsType?: string; + /** + * 获取到地理坐标的时间戳信息 + * 时间戳值为从1970年1月1日至今的毫秒数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + timestamp?: number; + /** + * 获取到地理位置对应的地址信息 + * 获取地址信息需要连接到服务器进行解析，所以会消耗更多的资源，如果不需要获取地址信息可通过设置PositionOptions参数的geocode属性值为false避免获取地址信息。 + * 如果没有获取到地址信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + address?: PlusGeolocationAddress; + /** + * 获取完整地址描述信息 + * 如果没有获取到地址信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + addresses?: string; +} + +/** + * JSON对象，地址信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ +interface PlusGeolocationAddress { + /** + * 国家 + * 如“中国”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + country?: string; + /** + * 省份名称 + * 如“北京市”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + province?: string; + /** + * 城市名称 + * 如“北京市”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + city?: string; + /** + * 区（县）名称 + * 如“朝阳区”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + district?: string; + /** + * 街道信息 + * 如“酒仙桥路”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + street?: string; + /** + * 获取街道门牌号信息 + * 如“3号”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + streetNum?: string; + /** + * POI信息 + * 如“电子城．国际电子总部”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + poiName?: string; + /** + * 邮政编码 + * 如“100016”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + postalCode?: string; + /** + * 城市代码 + * 如“010”，如果无法获取此信息则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + cityCode?: string; +} + +/** + * JSON对象，地理坐标信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ +interface PlusGeolocationCoordinates { + /** + * 坐标纬度值 + * 数据类型对象，地理坐标中的纬度值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + latitude?: number; + /** + * 坐标经度值 + * 数据类型对象，地理坐标中的经度值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + longitude?: number; + /** + * 海拔信息 + * 数据类型对象，如果无法获取此信息，则此值为空（null）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + altitude?: number; + /** + * 地理坐标信息的精确度信息 + * 数据类型对象，单位为米，其有效值必须大于0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + accuracy?: number; + /** + * 海拔的精确度信息 + * 数据类型对象，单位为米，其有效值必须大于0。如果无法获取海拔信息，则此值为空（null）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + altitudeAccuracy?: number; + /** + * 表示设备移动的方向 + * 数据类型对象，范围为0到360，表示相对于正北方向的角度。如果无法获取此信息，则此值为空（null）。如果设备没有移动则此值为NaN。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + heading?: number; + /** + * 表示设备移动的速度 + * 数据类型对象，单位为米每秒（m/s），其有效值必须大于0。如果无法获取速度信息，则此值为空（null）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + speed?: number; +} + +/** + * JSON对象，监听设备位置信息参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ +interface PlusGeolocationPositionOptions { + /** + * 是否高精确度获取位置信息 + * 高精度获取表示需要使用更多的系统资源，默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + enableHighAccuracy?: boolean; + /** + * 获取位置信息的超时时间 + * 单位为毫秒（ms），默认值为不超时。如果在指定的时间内没有获取到位置信息则触发错误回调函数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + timeout?: number; + /** + * 获取位置信息的间隔时间 + * 单位为毫秒（ms），默认值为5000（即5秒）。调用plus.geolocation.watchPosition时为更新位置信息的间隔时间。 + * 注意：在不同定位模块下支持范围值可能不同，如百度定位模块的间隔范围为大于等于1秒，如果设置的值小于最小值则使用最小值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + maximumAge?: number; + /** + * 优先使用的定位模块 + * 可取以下供应者： + * "system"：表示系统定位模块，支持wgs84坐标系； + * "baidu"：表示百度定位模块，支持gcj02/bd09/bd09ll坐标系； + * "amap"：表示高德定位模块，支持gcj02坐标系。 + * 默认值按以下优先顺序获取（amap>baidu>system），若指定的provider不存在或无效则返回错误回调。 + * 注意：百度/高德定位模块需要配置百度/高德地图相关参数才能正常使用。 + * - system: 优先使用系统定位模块 + * - baidu: 优先使用百度定位模块 + * - amap: 优先使用高德定位模块 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + provider?: 'system' | 'baidu' | 'amap'; + /** + * 指定获取的定位数据坐标系类型 + * 可取以下坐标系类型： + * "wgs84"：表示WGS-84坐标系； + * "gcj02"：表示国测局经纬度坐标系； + * "bd09"：表示百度墨卡托坐标系； + * "bd09ll"：表示百度经纬度坐标系； + * provider为"system"时，支持wgs84坐标系，默认使用"wgs84"坐标系； + * provider为"baidu"时，支持gcj02/bd09/bd09ll坐标系，默认使用"gcj02"坐标系； + * provider为"amap"时，支持gcj02坐标系，默认使用"gcj02"坐标系。 + * 如果设置的坐标系类型provider不支持，则返回错误。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + coordsType?: string; + /** + * 是否解析地址信息 + * 解析的地址信息保存到Position对象的address、addresses属性中，true表示解析地址信息，false表示不解析地址信息，返回的Position对象的address、addresses属性值为undefined，默认值为true。 + * 如果解析地址信息失败则返回的Position对象的address、addresses属性值为null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + geocode?: boolean; +} + +/** + * JSON对象，定位错误信息 + *

+ * 这里根据W3C规范定义了定位标准错误码，在此基础上5+ 扩展了错误码，参考 5+ API错误代码中的“Geolocation模块错误” + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ +interface PlusGeolocationGeolocationError { + /** + * 访问权限被拒绝 + * 系统不允许程序获取定位功能，错误代码常量值为1。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + PERMISSION_DENIED?: number; + /** + * 位置信息不可用 + * 无法获取有效的位置信息，错误代码常量值为2。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + POSITION_UNAVAILABLE?: number; + /** + * 获取位置信息超时 + * 无法在指定的时间内获取位置信息，错误代码常量值为3。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + TIMEOUT?: number; + /** + * 错误代码 + *

+ * 可取值： + *

    + *
  • PERMISSION_DENIED - 用户拒绝授权
    • + *
  • POSITION_UNAVAILABLE - 位置服务不可用，如系统定位服务关闭
    • + *
  • TIMEOUT - 定位超时，定位时超过PositionOptions.timeout设置的时间触发，此时通常可以重试
    • + *
  • 其它错误 - 5+ 扩展错误码，参考 5+ API错误代码中的“Geolocation模块错误”
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + code?: number; + /** + * 错误描述信息 + * 详细错误描述信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/geolocation.html](http://www.html5plus.org/doc/zh_cn/geolocation.html) + */ + message?: string; +} + +/** + * iBeacon模块用于搜索附件的iBeacon设备。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ +interface PlusIbeacon { + /** + * iBeacon设备信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + IBeaconInfo?: PlusIbeaconIBeaconInfo; + /** + * 开始搜索附近的iBeacon设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + startBeaconDiscoveryOptions?: PlusIbeaconStartBeaconDiscoveryOptions; + /** + * 停止搜索附近的iBeacon设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + stopBeaconDiscoveryOptions?: PlusIbeaconStopBeaconDiscoveryOptions; + /** + * 获取已搜索到的iBeacon设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + getBeaconsOptions?: PlusIbeaconGetBeaconsOptions; + /** + * 开始搜索附近的iBeacon设备 + * 搜索成功后触发successCB回调，失败触发errorCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + startBeaconDiscovery(options: PlusIbeaconStartBeaconDiscoveryOptions): void; + /** + * 停止搜索附近的iBeacon设备 + * 取消成功后触发successCB回调，失败触发errorCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + stopBeaconDiscovery(options: PlusIbeaconStopBeaconDiscoveryOptions): void; + /** + * 获取已搜索到的iBeacon设备 + * 获取成功后触发successCB回调，失败触发errorCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + getBeacons(options: PlusIbeaconGetBeaconsOptions): void; + /** + * 监听iBeacon设备更新 + * iBeacon设备更新后触发updateCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + onBeaconUpdate(updateCB: (result: any) => void): void; + /** + * 监听iBeacon服务状态变化 + * iBeacon服务状态变化时触发changeCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + onBeaconServiceChange(changeCB: (result: any) => void): void; +} + +/** + * iBeacon设备信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ +interface PlusIbeaconIBeaconInfo { + /** + * iBeacon设备广播的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + uuid?: string; + /** + * iBeacon设备的主id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + major?: string; + /** + * iBeacon设备的次id + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + minor?: string; + /** + * iBeacon设备的距离 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + proximity?: number; + /** + * iBeacon设备的距离精度信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + accuracy?: number; + /** + * iBeacon设备的信号强度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + rssi?: string; +} + +/** + * 开始搜索附近的iBeacon设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ +interface PlusIbeaconStartBeaconDiscoveryOptions { + /** + * 要搜索设备的uuid + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + uuids?: string []; + /** + * 是否校验蓝牙开关 + * Android平台忽略此属性，iOS平台默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + ignoretoothAvailable?: boolean; + /** + * 搜索设备成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + success?: (result: any) => void; + /** + * 搜索设备失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + fail?: (result: any) => void; + /** + * 搜索设备操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + complete?: (result: any) => void; +} + +/** + * 停止搜索附近的iBeacon设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ +interface PlusIbeaconStopBeaconDiscoveryOptions { + /** + * 停止搜索成功回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + success?: (result: any) => void; + /** + * 停止搜索失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + fail?: (result: any) => void; + /** + * 停止搜索操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取已搜索到的iBeacon设备 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ +interface PlusIbeaconGetBeaconsOptions { + /** + * 获取设备成功回调函数 + * 回调函数参数event对象包括以下属性： + * beacons - Array<IBeaconInfo>类型，iBeacon设备列表信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + success?: (result: any) => void; + /** + * 获取设备失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + fail?: (result: any) => void; + /** + * 获取设备操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ibeacon.html](http://www.html5plus.org/doc/zh_cn/ibeacon.html) + */ + complete?: (result: any) => void; +} + +/** + * IO模块管理本地文件系统，用于对文件系统的目录浏览、文件的读取、文件的写入等操作。通过plus.io可获取文件系统管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIo { + /** + * 文件系统中的目录对象，用于管理特定的本地目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + DirectoryEntry?: PlusIoDirectoryEntry; + /** + * 读取目录信息对象，用于获取目录中包含的文件及子目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + DirectoryReader?: PlusIoDirectoryReader; + /** + * 文件系统中的文件数据对象，用于获取文件的数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + File?: PlusIoFile; + /** + * 文件系统中的文件对象，用于管理特定的本地文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + FileEntry?: PlusIoFileEntry; + /** + * 文件系统中的读取文件对象，用于获取文件的内容 + * FileReader对象是从设备文件系统读取文件FileReader对象是从设备文件系统读取文件的一种方式，文件以文本或者Base64编码的字符串形式读出来。 + * 用户注册自己的事件监听器来接收loadstart、progress、load、loadend、error和abort事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + FileReader?: typeof PlusIoFileReader; + /** + * 文件系统中的写文件对象，用于写入文件内容 + * FileWriter对象是向设备文件系统写入文件的一种方式，用户注册自己的事件监听器来接收writestart、progress、write、writeend、error和abort事件。 + * 一个FileWriter对象是为单个文件的操作而创建，可以使用该对象多次对相应文件进行写入操作。 + * FileWriter维护该文件的指针位置及长度属性，这样就可以寻找和写入文件的任何地方。 + * 默认情况下，FileWriter从文件的开头开始写入（将覆盖现有数据），seek方法可设置文件操作指定位置，如fw.seek(fw.length-1)写入操作就会从文件的末尾开始。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + FileWriter?: PlusIoFileWriter; + /** + * 文件系统对象，用于管理特定本地文件目录 + * 文件系统对象表示一个应用可访问的根目录。name属性用于标识此根目录的名称，与LocalFileSystem中的文件系统类型一一对应。root属性为文件目录对象，用于实际操作文件系统，参考DirectoryEntry。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + FileSystem?: PlusIoFileSystem; + /** + * JSON对象，获取文件操作的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + Flags?: PlusIoFlags; + /** + * JSON对象，保存文件或目录的状态信息对象 + * 可通过DirectoryEntry或FileEntry对象的getMetaData方法获取 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + Metadata?: PlusIoMetadata; + /** + * 文件或目录操作事件对象 + * 所有文件或目录操作事件回调函数中都创建该对象的实例。 + * 该对象从DOMEvent继承而来，可通过该其target属性获取事件触发的文件或目录操作对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + FileEvent?: PlusIoFileEvent; + /** + * 相对路径URL + * 用于访问5+ API中定义的应用沙盒目录，以“_”开头。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + RelativeURL?: PlusIoRelativeURL; + /** + * 本地绝对路径URL + * 可在html页面中直接访问本地文件系统资源，以“file://”开头，后面跟随系统的绝对路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + LocalURL?: PlusIoLocalURL; + /** + * 网络路径URL + * 可在html页面中以网络资源模式访问本地资源，以“http://”开头，后面跟随相对路径。 + * 如“http://www.dcloud.io/icon.png”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + RemoteURL?: PlusIoRemoteURL; + /** + * JSON对象，音频文件信息对象 + * 通过getAudioInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + AudioInfo?: PlusIoAudioInfo; + /** + * JSON对象，文件信息对象 + * 通过getFileInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + FileInfo?: PlusIoFileInfo; + /** + * JSON对象，图片信息对象 + * 通过getImageInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + ImageInfo?: PlusIoImageInfo; + /** + * JSON对象，视频文件信息对象 + * 通过getVideoInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + VideoInfo?: PlusIoVideoInfo; + /** + * 应用私有资源目录常量 + *

+ * 本地文件系统常量，Number类型，固定值1，对应相对路径URL为"_www"开头的地址。 + * 应用所有资源保存到此目录，仅本应用可访问。 + * 为了确保应用资源的安全性，通常此目录只可读。 + * 注意： + * 需要将应用设置为释放资源模式才能访问此目录，配置方法： + *

    + *
  • uni-app项目，在manifest.json的"app-plus"节点下添加"runmode":"liberate"
    • + *
  • 5+ App项目，在manifest.json的"plus"节点下添加"runmode":"liberate"
    • + *
+ * 提交云端打包生效，详见manifest.json的runmode配置 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + PRIVATE_WWW?: number; + /** + * 应用私有文档目录常量 + * 本地文件系统常量，Number类型，固定值2，对应 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + PRIVATE_DOC?: number; + /** + * 应用公共文档目录常量 + * 本地文件系统常量，Number类型，固定值3，对应 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + PUBLIC_DOCUMENTS?: number; + /** + * 应用公共下载目录常量 + * 本地文件系统常量，Number类型，固定值4，对应 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + PUBLIC_DOWNLOADS?: number; + /** + * 获取音频文件信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getAudioInfoOptions?: PlusIoGetAudioInfoOptions; + /** + * 获取文件信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getFileInfoOptions?: PlusIoGetFileInfoOptions; + /** + * 获取图片信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getImageInfoOptions?: PlusIoGetImageInfoOptions; + /** + * 获取视频文件信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getVideoInfoOptions?: PlusIoGetVideoInfoOptions; + /** + * 请求本地文件系统对象 + * 获取指定的文件系统，可通过type指定获取文件系统的类型。 + * 获取指定的文件系统对象成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + requestFileSystem(type: PlusIo['PRIVATE_WWW'] | PlusIo['PRIVATE_DOC'] | PlusIo['PUBLIC_DOCUMENTS'] | PlusIo['PUBLIC_DOWNLOADS'], succesCB: (result: PlusIoFileSystem) => void, errorCB?: (result: any) => void): void; + /** + * 通过URL参数获取目录对象或文件对象 + * 快速获取指定的目录或文件操作对象，如通过URL值“_www/test.html”可直接获取文件操作对象。 + * url值可支持相对路径URL、本地路径URL。 + * 获取指定的文件或目录操作对象成功通过succesCB回调返回，如果指定URL路径或文件不存在则失败通过errorCB回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + resolveLocalFileSystemURL(url : string, succesCB: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 将本地URL路径转换成平台绝对路径 + * 绝对路径符合各平台文件路径格式，通常用于Native.JS调用系统原生文件操作API，也可以在前面添加“file://”后在html页面中直接使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + convertLocalFileSystemURL(url: string): string; + /** + * 将平台绝对路径转换成本地URL路径 + * 绝对路径符合各平台文件路径格式，转换后变成RelativeURL类型格式。 + * 功能与convertLocalFileSystemURL方法相反，将绝对路径转换成相对路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + convertAbsoluteFileSystem(path: string): string; + /** + * 获取音频文件信息 + * 仅支持获取本地音频文件信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getAudioInfo(options: PlusIoGetAudioInfoOptions): void; + /** + * 获取文件信息 + * 支持获取本地文件信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getFileInfo(options: PlusIoGetFileInfoOptions): void; + /** + * 获取图片信息 + * 支持获取本地图片和网络图片的信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getImageInfo(options: PlusIoGetImageInfoOptions): void; + /** + * 获取视频文件信息 + * 仅支持获取本地视频文件信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getVideoInfo(options: PlusIoGetVideoInfoOptions): void; +} + +/** + * 文件系统中的目录对象，用于管理特定的本地目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoDirectoryEntry { + /** + * 操作对象的是否为文件，DirectoryEntry对象固定其值为false + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + isFile?: boolean; + /** + * 操作对象是否为目录，DirectoryEntry对象固定其值为true + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + isDirectory?: boolean; + /** + * 目录操作对象的名称，不包括路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + name?: string; + /** + * 目录操作对象的完整路径，文件系统的绝对路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fullPath?: string; + /** + * 文件操作对象所属的文件系统对象，参考FileSystem + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fileSystem?: PlusIoFileSystem; + /** + * 获取目录的属性 + * 用于获取文件或目录的属性信息。 + * 获取属性信息成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getMetadata(succesCB: (result: PlusIoMetadata) => void, errorCB: (result: any) => void, recursive?: boolean): void; + /** + * 移动目录 + * 以下情况移动目录将会导致失败： + * 将父目录移动到子目录中； + * 要移动到的目标目录无效； + * 要移动到的目标路径被文件占用； + * 要移动到的目标目录已经存在并且不为空。 + * 移动目录成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + moveTo(parent: PlusIoDirectoryEntry, newName?: string, succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 拷贝目录 + * 以下情况拷贝目录将会导致失败： + * 将父目录拷贝到子目录中； + * 要拷贝到的目标目录无效； + * 要拷贝到的目标路径被文件占用； + * 要拷贝到的目标目录已经存在并且不为空。 + * 拷贝目录成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + copyTo(parent: PlusIoDirectoryEntry, newName?: string, succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 获取目录路径转换为URL地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + toURL(): string; + /** + * 获取目录路径转换为本地路径URL地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + toLocalURL(): string; + /** + * 获取目录路径转换为网络路径URL地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + toRemoteURL(): string; + /** + * 删除目录 + * 以下情况删除目录将会导致失败： + * 目录中存在文件； + * 删除根目录； + * 删除目录成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + remove(succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 获取目录所属的父目录 + * 获取父目录成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getParent(succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 创建目录读取对象 + * 创建一个目录读取对象，用户读取目下的文件及子目录。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + createReader(): PlusIoDirectoryReader; + /** + * 创建或打开子目录 + * 创建或打开当前目录指定的目录。 + * 创建或打开目录操作成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getDirectory(path: string, flag?: PlusIoFlags, succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 创建或打开文件 + * 创建或打开当前目录下指定的文件。 + * 创建或打开文件操作对象成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getFile(path: string, flag?: PlusIoFlags, succesCB?: (result: PlusIoFileEntry) => void, errorCB?: (result: any) => void): void; + /** + * 递归删除目录 + * 删除目录将会删除其下的所有文件及子目录 + * 不能删除根目录，如果操作删除根目录将会删除目录下的文件及子目录，不会删除根目录自身。 + * 删除目录成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + removeRecursively(succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; +} + +/** + * 读取目录信息对象，用于获取目录中包含的文件及子目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoDirectoryReader { + /** + * 获取当前目录中的所有文件和子目录 + * 获取当前目录下的所有文件和子目录。 + * 获取操作成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + readEntries(succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; +} + +/** + * 文件系统中的文件数据对象，用于获取文件的数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFile { + /** + * 文件数据对象的数据大小，单位为字节 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + size?: number; + /** + * 文件数据对象MIME类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + type?: string; + /** + * 文件数据对象的名称，不包括路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + name?: string; + /** + * 文件对象的最后修改时间 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + lastModifiedDate?: Date; + /** + * 获取文件指定的数据内容 + * 获取文件指定的数据内容，其中end必须大于start。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + slice(start?: number, end?: number): PlusIoFile; + /** + * 关闭文件数据对象 + * 当文件数据对象不再使用时，可通过此方法关闭，释放系统资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + close(): void; +} + +/** + * 文件系统中的文件对象，用于管理特定的本地文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFileEntry { + /** + * 文件操作对象的是否为文件，FileEntry对象固定其值为true + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + isFile?: boolean; + /** + * 文件操作对象是否为目录，FileEntry对象固定其值为false + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + isDirectory?: boolean; + /** + * 文件操作对象的名称，不包括路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + name?: string; + /** + * 文件操作对象的完整路径，文件系统的绝对路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fullPath?: string; + /** + * 文件操作对象所属的文件系统对象，参考FileSystem + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fileSystem?: PlusIoFileSystem; + /** + * 获取文件的属性信息 + * 用于获取文件的属性信息。 + * 获取属性信息成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getMetadata(succesCB: (result: PlusIoMetadata) => void, errorCB: (result: any) => void): void; + /** + * 移动文件 + * 以下情况移动目录将会导致失败： + * 要移动到的目标目录无效； + * 要移动到的目标路径被其它文件占用； + * 移动文件成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + moveTo(parent: PlusIoDirectoryEntry, newName?: string, succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 拷贝文件 + * 以下情况拷贝文件将会导致失败： + * 要拷贝到的目标目录无效； + * 要拷贝到的目标路径被其它文件占用； + * 拷贝文件成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + copyTo(parent: PlusIoDirectoryEntry, newName?: string, succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 获取文件路径转换为URL地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + toURL(): string; + /** + * 获取文件路径转换为本地路径URL地址 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + toLocalURL(): string; + /** + * 获取文件路径转换为网络路径URL地址 + * URL地址格式为以“http://localhost:13131/”开头的网络路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + toRemoteURL(): string; + /** + * 删除文件 + * 删除文件成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + remove(succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 获取文件所属的父目录 + * 获取父目录成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + getParent(succesCB?: (result: PlusIoDirectoryEntry) => void, errorCB?: (result: any) => void): void; + /** + * 获取文件关联的写文件操作对象FileWriter + * 获取写文件操作对象成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + createWriter(succesCB?: (result: PlusIoFileWriter) => void, errorCB?: (result: any) => void): void; + /** + * 获取文件数据对象 + * 获取文件数据对象成功通过succesCB回调返回，失败则通过errorCB返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + file(succesCB?: (result: PlusIoFile) => void, errorCB?: (result: any) => void): void; +} + +/** + * 文件系统中的读取文件对象，用于获取文件的内容 + * FileReader对象是从设备文件系统读取文件FileReader对象是从设备文件系统读取文件的一种方式，文件以文本或者Base64编码的字符串形式读出来。 + * 用户注册自己的事件监听器来接收loadstart、progress、load、loadend、error和abort事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +declare class PlusIoFileReader { + /** + * 值为0，开始读取文件状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + EMPTY?: number; + /** + * 值为1，正在读取文件状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + LOADING?: number; + /** + * 值为2，读文件操作完成状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + DONE?: number; + /** + * 当前读取文件所处的状态 + * 可取上面定义的常量值，EMPTY（0）、LOADING（1）、DONE（2）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + readyState?: number; + /** + * 已读取文件的内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + result?: string; + /** + * 文件操作错误代码 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + error?: number; + /** + * 读取文件开始时的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onloadstart?: (result: PlusIoFileEvent) => void; + /** + * 读取文件成功完成的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onload?: (result: PlusIoFileEvent) => void; + /** + * 取消读取文件时的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onabort?: (result: PlusIoFileEvent) => void; + /** + * 文件读取操作失败时调用的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onerror?: (result: PlusIoFileEvent) => void; + /** + * 文件读取操作完成时的回调函数 + * 不管成功或失败都会触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onloadend?: (result: PlusIoFileEvent) => void; + /** + * 终止文件读取操作 + * 读取文件操作开始后，可通过此方法取消读取文件。 + * 调用此方法后将触发文件读取对象的onabort事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + abort(): void; + /** + * 以URL编码格式读取文件数据内容 + * 读取文件的数据内容，并将数据内容进行URL编码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + readAsDataURL(file: PlusIoFile, encoding ?: string): void; + /** + * 以文本格式读取文件数据内容 + * 读取文件的数据内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + readAsText(file: PlusIoFile, encoding ?: string): void; + /** + * 创建读取文件对象 + * 创建读取文件对象 + */ + constructor(); +} + +/** + * 文件系统中的写文件对象，用于写入文件内容 + * FileWriter对象是向设备文件系统写入文件的一种方式，用户注册自己的事件监听器来接收writestart、progress、write、writeend、error和abort事件。 + * 一个FileWriter对象是为单个文件的操作而创建，可以使用该对象多次对相应文件进行写入操作。 + * FileWriter维护该文件的指针位置及长度属性，这样就可以寻找和写入文件的任何地方。 + * 默认情况下，FileWriter从文件的开头开始写入（将覆盖现有数据），seek方法可设置文件操作指定位置，如fw.seek(fw.length-1)写入操作就会从文件的末尾开始。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFileWriter { + /** + * 值为0，写文件初始化状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + INIT?: number; + /** + * 值为1，正在写入文件状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + WRITING?: number; + /** + * 值为2，写文件操作完成状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + DONE?: number; + /** + * 当前写入文件所处的状态 + * 可取上面定义的常量值，INIT(0)、WRITING（1）、DONE（2）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + readyState?: number; + /** + * 文件当前的长度，单位为字节 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + length?: number; + /** + * 文件当前操作的指针位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + position?: number; + /** + * 文件写入操作错误代码 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + error?: number; + /** + * 写入文件开始时的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onwritestart?: (result: PlusIoFileEvent) => void; + /** + * 写入文件成功完成的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onwrite?: (result: PlusIoFileEvent) => void; + /** + * 取消写入文件时的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onabort?: (result: PlusIoFileEvent) => void; + /** + * 文件写入操作失败时调用的回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onerror?: (result: PlusIoFileEvent) => void; + /** + * 文件写入操作完成时的回调函数 + * 不管成功或失败都会触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + onwriteend?: (result: PlusIoFileEvent) => void; + /** + * 终止文件写入操作 + * 写入文件数据操作开始后，可通过此方法取消写入文件数据操作。 + * 调用此方法后将触发文件写入对象的onabort事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + abort(): void; + /** + * 定位文件操作位置 + * 定位文件的操作位置，有效值为0到文件的总长度减1。 + * 0表示文件的起始位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + seek(position: number): void; + /** + * 按照指定长度截断文件 + * 从文件当前定位的位置开始，按照指定长度截断文件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + truncate(length : number): void; + /** + * 向文件中写入数据 + * 从文件当前定位的位置开始，写入数据到文件中。 + * 如果文件中已经存在数据，新写入的数据将覆盖已有数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + write(data : string): void; + /** + * 向文件中写入数据 + * 从文件当前定位的位置开始，写入数据到文件中。 + * 如果文件中已经存在数据，新写入的数据将覆盖已有数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + writeAsBinary(data : string): void; +} + +/** + * 文件系统对象，用于管理特定本地文件目录 + * 文件系统对象表示一个应用可访问的根目录。name属性用于标识此根目录的名称，与LocalFileSystem中的文件系统类型一一对应。root属性为文件目录对象，用于实际操作文件系统，参考DirectoryEntry。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFileSystem { + /** + * 文件系统的名称 + * 值为文件系统类型常量值字符串，如“PRIVATE_WWW”、“PRIVATE_DOCUMENTS”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + name?: string; + /** + * 文件系统的根目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + root?: PlusIoDirectoryEntry; +} + +/** + * JSON对象，获取文件操作的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFlags { + /** + * 是否创建对象标记 + * 指示如果文件或目录不存在时是否进行创建，默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + create?: boolean; + /** + * 反向操作标记 + * 其本身没有任何效果，需与create属性值设置为true时一起使用，如果目标文件或目录已经存在则会导致文件或目录打开失败，默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + exclusive?: boolean; +} + +/** + * JSON对象，保存文件或目录的状态信息对象 + * 可通过DirectoryEntry或FileEntry对象的getMetaData方法获取 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoMetadata { + /** + * 文件或目录的最后修改时间 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + modificationTime?: Date; + /** + * 文件的大小 + * 若获取的是目录对象的属性则值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + size?: number; + /** + * 包含的子目录数 + * 若自身是文件则其值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + directoryCount?: number; + /** + * 目录的文件数 + * 若自身是文件则其值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fileCount?: number; +} + +/** + * 文件或目录操作事件对象 + * 所有文件或目录操作事件回调函数中都创建该对象的实例。 + * 该对象从DOMEvent继承而来，可通过该其target属性获取事件触发的文件或目录操作对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFileEvent { + /** + * 文件或目录操作对象 + * 在不同的回调中指向的对象不同，可指向的对象包括：FileEntry、DirectoryEntry、FileReader、FileWriter。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + target?: PlusIoDirectoryEntry; +} + +/** + * 相对路径URL + * 用于访问5+ API中定义的应用沙盒目录，以“_”开头。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoRelativeURL { + /** + * 应用私有资源目录 + *

+ * 对应常量plus.io.PRIVATE_WWW，仅应用自身可读。 + * 保存应用的所有html、css、js等资源文件，“_www”后面加资源相对路径，如“_www/res/icon.png”。 + * 注意：应用资源目录是只读目录，只能读取此目录下的文件，不能修改或新建。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + _www?: string; + /** + * 应用私有文档目录 + *

+ * 对应常量plus.io.PRIVATE_DOC，仅应用自身可读写。 + * 用于保存应用运行期业务逻辑数据，“_doc”后面加资源相对路径，如“_doc/userdata.json”。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + _doc?: string; + /** + * 程序公用文档目录 + *

+ * 对应常量plus.io.PUBLIC_DOCUMENTS，多应用时都可共享读写。 + * 用于保存程序中各应用间可共享文件的目录，“_document”后面加资源相对路径，如“_document/share.doc”。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + _documents?: string; + /** + * 程序公用下载目录 + *

+ * 对应常量plus.io.PUBLIC_DOWNLOADS，多应用时都可共享读写。 + * 用于保存程序中各应用间可共享的下载文件目录，“_download”后面加资源相对路径，，如“_download/mydoc.doc”。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + _downloads?: string; +} + +/** + * 本地绝对路径URL + * 可在html页面中直接访问本地文件系统资源，以“file://”开头，后面跟随系统的绝对路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +type PlusIoLocalURL = any; +/** + * 网络路径URL + * 可在html页面中以网络资源模式访问本地资源，以“http://”开头，后面跟随相对路径。 + * 如“http://www.dcloud.io/icon.png”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +type PlusIoRemoteURL = any; + +/** + * JSON对象，音频文件信息对象 + * 通过getAudioInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoAudioInfo { + /** + * 音频长度 + * 单位为秒（s）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + duration?: number; +} + +/** + * JSON对象，文件信息对象 + * 通过getFileInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoFileInfo { + /** + * 文件摘要 + * 按照传入的 digestAlgorithm 计算得出的文件摘要信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + digest?: string; + /** + * 文件大小 + * 单位为字节。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + size?: number; +} + +/** + * JSON对象，图片信息对象 + * 通过getImageInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoImageInfo { + /** + * 图片的原始高度 + * 若获取的是目录对象的属性则值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + height?: number; + /** + * 拍照时设备方向信息 + * 可取值： + * "up" - 默认方向（手机横持拍照），对应 Exif 中的 1，或无 orientation 信息； + * "up-mirrored" - 同 up，但镜像翻转，对应 Exif 中的 2； + * "down" - 旋转180度，对应 Exif 中的 3； + * "down-mirrored" - 同 down，但镜像翻转，对应 Exif 中的 4； + * "left-mirrored" - 同 left，但镜像翻转，对应 Exif 中的 5； + * "right" - 顺时针旋转90度，对应 Exif 中的 6； + * "right-mirrored" - 同 right，但镜像翻转，对应 Exif 中的 7； + * "left" - 逆时针旋转90度，对应 Exif 中的 8。 + * 更多详情参考图片扩展中的方向信息：http://sylvana.net/jpegcrop/exif_orientation.html。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + orientation?: string; + /** + * 图片的本地路径 + * 绝对路径，以"file://"开头。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + path?: string; + /** + * 图片格式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + type?: string; + /** + * 图片的原始宽度 + * 单位为像素（px），不考虑旋转。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + width?: number; +} + +/** + * JSON对象，视频文件信息对象 + * 通过getVideoInfo方法的成功回调函数返回 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoVideoInfo { + /** + * 视频码率 + *

+ * 单位为kbps。 + * 注意：HBuilderX3.1.14+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + bitrate?: number; + /** + * 视频长度 + * 单位为秒（s）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + duration?: number; + /** + * 视频高度 + * 视频的真实像素值高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + height?: number; + /** + * 画面方向 + *

+ * 取值范围： + *

    + *
  • up - 表示正常方向
    • + *
  • down - 表示方向旋转180度
    • + *
  • left - 表示方向逆时针旋转90度
    • + *
  • right - 表示方向顺时针旋转90度
    • + *
+ * 注意：HBuilderX3.1.14+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + orientation?: string; + /** + * 视频分辨率 + * 格式为“宽*高”，如“1280*720”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + resolution?: string; + /** + * 文件大小 + * 单位为字节。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + size?: number; + /** + * 视频格式 + *

+ * 注意：HBuilderX3.1.14+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + type?: string; + /** + * 视频宽度 + * 视频的真实像素值宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + width?: number; +} + +/** + * 获取音频文件信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoGetAudioInfoOptions { + /** + * 音频文件的路径 + *

+ * 支持以下类型路径： + *

    + *
  • 相对路径 - 访问相对于当前页面host位置资源，如"a.mp3"
    • + *
  • 相对路径URL - 访问5+ API定义的应用沙盒目录， + * 参考：plus.io.RelativeURL
    • + *
  • 本地绝对路径URL - 访问应用沙盒目录外其它系统资源目录， + * 参考：plus.io.LocalURL
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + filePath?: string; + /** + * 获取音频文件信息成功回调函数 + *

+ * 回调函数的参数类型为AudioInfo。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + success?: (result: any) => void; + /** + * 获取音频文件信息失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fail?: (result: any) => void; + /** + * 获取音频文件信息操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取文件信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoGetFileInfoOptions { + /** + * 文件的路径 + *

+ * 支持以下类型路径： + *

    + *
  • 相对路径 - 访问相对于当前页面host位置资源，如"a.mp3"
    • + *
  • 相对路径URL - 访问5+ API定义的应用沙盒目录， + * 参考：plus.io.RelativeURL
    • + *
  • 本地绝对路径URL - 访问应用沙盒目录外其它系统资源目录， + * 参考：plus.io.LocalURL
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + filePath?: string; + /** + * 计算文件摘要的算法 + * 可取值： + * "md5" - 使用md5算法计算摘要信息； + * "sha1" - 使用sha1算法计算摘要信息。 + * 默认值为"md5"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + digestAlgorithm?: string; + /** + * 获取文件信息成功回调函数 + *

+ * 回调函数的参数类型为FileInfo。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + success?: (result: any) => void; + /** + * 获取文件信息失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fail?: (result: any) => void; + /** + * 获取文件信息操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取图片信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoGetImageInfoOptions { + /** + * 图片的路径 + *

+ * 支持以下类型路径： + *

    + *
  • 相对路径 - 访问相对于当前页面host位置资源，如"a.mp3"
    • + *
  • 相对路径URL - 访问5+ API定义的应用沙盒目录， + * 参考：plus.io.RelativeURL
    • + *
  • 本地绝对路径URL - 访问应用沙盒目录外其它系统资源目录， + * 参考：plus.io.LocalURL
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + src?: string; + /** + * 获取图片信息成功回调函数 + *

+ * 回调函数的参数类型为ImageInfo。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + success?: (result: any) => void; + /** + * 获取图片信息失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fail?: (result: any) => void; + /** + * 获取图片信息操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + complete?: (result: any) => void; +} + +/** + * 获取视频文件信息 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ +interface PlusIoGetVideoInfoOptions { + /** + * 视频文件的路径 + *

+ * 支持以下类型路径： + *

    + *
  • 相对路径 - 访问相对于当前页面host位置资源，如"a.mp3"
    • + *
  • 相对路径URL - 访问5+ API定义的应用沙盒目录， + * 参考：plus.io.RelativeURL
    • + *
  • 本地绝对路径URL - 访问应用沙盒目录外其它系统资源目录， + * 参考：plus.io.LocalURL
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + filePath?: string; + /** + * 获取视频文件信息成功回调函数 + *

+ * 回调函数的参数类型为VideoInfo。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + success?: (result: any) => void; + /** + * 获取视频文件信息失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + fail?: (result: any) => void; + /** + * 获取视频文件信息操作完成回调函数 + * 调用成功或失败都会触发此回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/io.html](http://www.html5plus.org/doc/zh_cn/io.html) + */ + complete?: (result: any) => void; +} + +/** + * Native.js for iOS封装一条通过JS语法直接调用Native Objective-C接口通道，通过plus.ios可调用几乎所有的系统API。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ +interface PlusIos { + /** + * Objective-C类对象 + * Objective-C类对象，可通过其属性获取类的常量，可通过方法来操作类的静态方法，也通过new方法来创建类的实例对象。 + * 对于类的静态方法，则直接通过.后面跟随方法名称调用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + ClassObject?: PlusIosClassObject; + /** + * Objective-C实例对象 + * Objective-C实例对象，可通过其方法来操作示例的变量和方法。 + * 注意：必须通过plusGetAttribute()方法读取示例对象的属性值，通过plusSetAttribute()方法设置示例对象的属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + InstanceObject?: PlusIosInstanceObject; + /** + * 导入Objective-C类对象 + * 导入类对象后，就可以通过.操作符直接调用对象（类对象/实例对象）的方法。 + * 通过.操作符号调用方法时，不需要使用":"来分割参数。 + * 注意：导入类对象将会消耗较多的系统资源，不应该导入过多的类对象，可以使用plus.ios.invoke()来调用未导入类实例对象的方法。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + importClass(classname: string | PlusIosInstanceObject): PlusIosClassObject; + /** + * 创建实例对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + newObject(classname: string, args?: any): PlusIosInstanceObject; + /** + * 销毁实例对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + deleteObject(obj: any): void; + /** + * 调用对象（类对象/示例对象）的方法 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + invoke(obj: PlusIosInstanceObject | PlusIosClassObject | string, name: string, args?: any): any; + /** + * 实现代理的方法 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + implements(name: string, obj: any): PlusIosInstanceObject; + /** + * 获取当前Webview窗口对象的native层UIWebview实例对象 + * UIWebview对象的API请参考Apple开发文档 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + currentWebview(): PlusIosInstanceObject; +} + +/** + * Objective-C类对象 + * Objective-C类对象，可通过其属性获取类的常量，可通过方法来操作类的静态方法，也通过new方法来创建类的实例对象。 + * 对于类的静态方法，则直接通过.后面跟随方法名称调用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ +type PlusIosClassObject = any; + +/** + * Objective-C实例对象 + * Objective-C实例对象，可通过其方法来操作示例的变量和方法。 + * 注意：必须通过plusGetAttribute()方法读取示例对象的属性值，通过plusSetAttribute()方法设置示例对象的属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ +interface PlusIosInstanceObject { + /** + * 获取Objective-C实例对象的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + plusGetAttribute(name: string): any; + /** + * 设置Objective-C示例对象的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/ios.html](http://www.html5plus.org/doc/zh_cn/ios.html) + */ + plusSetAttribute(name: string, value: any): void; +} + +/** + * Key管理设备按键事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ +interface PlusKey { + /** + * 按键类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + KeyType?: PlusKeyKeyType; + /** + * 按键事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + KeyEvent?: PlusKeyKeyEvent; + /** + * 添加按键事件监听器 + * 添加按键事件监听器，当指定的按键事件发生时，回调函数将触发。 + * 应用中存在多个Webview窗口时，按照窗口的显示栈顺序从后往前查找，查找到添加按键事件监听器的窗口后停止（中断前面Webview窗口对按键事件的监听），并向窗口触发执行按键回调事件。 + * 在同一Webview窗口中可多次调用此方法对同一事件添加多个监听器，触发时按照添加的顺序先后调用。 + * 注意：此方法无法监听软键盘的按键事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + addEventListener(event: 'backbutton' | 'keydown' | 'keyup' | 'longpressed' | 'menubutton' | 'searchbutton' | 'volumeupbutton' | 'volumedownbutton', listener: (result: PlusKeyKeyEvent) => void, capture?: boolean): void; + /** + * 隐藏软键盘 + * 隐藏已经显示的软键盘，如果软键盘没有显示则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + hideSoftKeybord(): void; + /** + * 设置辅助输入类型 + * input的type类型为text获取焦点时，在软键盘上方显示辅助输入条方便用户快速输入。 + * 在页面中input编辑框type类型不为"tel"、"email"时生效（type为tel类型时一定显示tel的辅助输入条，type为email时一定显示email的辅助输入条）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + setAssistantType(type?: 'nick' | 'address' | 'tel' | 'email' | 'company' | 'tax' | 'id' | 'none'): void; + /** + * 显示软键盘 + * 强制显示系统软键盘，如果软键盘已经显示则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + showSoftKeybord(): void; + /** + * 移除按键事件监听器 + * 从窗口移除指定的事件监听器。若没有查找到对应的事件监听器，则无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + removeEventListener(event: 'backbutton' | 'keydown' | 'keyup' | 'longpressed' | 'menubutton' | 'searchbutton' | 'volumeupbutton' | 'volumedownbutton', listener: (result: PlusKeyKeyEvent) => void): void; +} + +/** + * 按键类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ +interface PlusKeyKeyType { + /** + * 设备“返回”按钮按键事件 + * 如果需要改变默认“返回”按钮的处理逻辑，则可通过plus.key.addEventListener来注册监听"backbutton"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + backbutton?: string; + /** + * 键按下事件 + * 如果需要改变默认键按下的处理逻辑，则可通过plus.key.addEventListener来注册监听"keydown"事件。 + * 可通过回调函数中KeyEvent对象的keyCode来获取按下的键值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + keydown?: string; + /** + * 键松开事件 + * 如果需要改变默认键松开的处理逻辑，则可通过plus.key.addEventListener来注册监听"keyup"事件。 + * 可通过回调函数中KeyEvent对象的keyCode来获取松开的键值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + keyup?: string; + /** + * 长按键事件 + * 如果需要改变默认长按键的处理逻辑，则可通过plus.key.addEventListener来注册监听"longpressed"事件。 + * 长按键时会多次触发回调函数，通过回调函数中KeyEvent对象的keyCode来获取长按的键值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + longpressed?: string; + /** + * 设备“菜单”按钮按键事件 + * 如果需要改变默认“菜单”按钮的处理逻辑，则可通过plus.key.addEventListener来注册监听"menubutton"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + menubutton?: string; + /** + * 设备“搜索”按钮按键事件 + * 如果需要改变默认“搜索”按钮的处理逻辑，则可通过plus.key.addEventListener来注册监听"searchbutton"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + searchbutton?: string; + /** + * 设备“音量+”按钮按键事件 + * 如果需要改变默认“音量+”按钮的处理逻辑，则可通过plus.key.addEventListener来注册监听"volumeupbutton"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + volumeupbutton?: string; + /** + * 设备“音量-”按钮按键事件 + * 如果需要改变默认“音量-”按钮的处理逻辑，则可通过plus.key.addEventListener来注册监听"volumedownbutton"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + volumedownbutton?: string; +} + +/** + * 按键事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ +interface PlusKeyKeyEvent { + /** + * 触发按键事件的键值 + * 键值由各系统平台定义，一些特殊按键在不同的设备上可能存在差异。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + keyCode?: number; + /** + * 按键事件类型 + * 用于表明触发此按键事件的类型，值为KeyType中定义的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/key.html](http://www.html5plus.org/doc/zh_cn/key.html) + */ + keyType?: PlusKeyKeyType; +} + +/** + * Messaging模块管理设备通讯功能，可用于短信、彩信、邮件发送等。通过plus.messaging可获取设备通讯管理对象。另外也可以直接通过html中的href直接快速发送短信、拨打电话、发送邮件等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ +interface PlusMessaging { + /** + * 消息对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + Message?: PlusMessagingMessage; + /** + * 消息体内容类型 + * 用于设定消息的消息体内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + BodyType?: PlusMessagingBodyType; + /** + * 简单短信类型常量 + * 消息类型常量，Number类型，固定值为1，用于创建并发送短信。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + TYPE_SMS?: number; + /** + * 彩信类型常量 + * 消息类型常量，Number类型，固定值为2，用于创建并发送多媒体短信（彩信）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + TYPE_MMS?: number; + /** + * 邮件类型常量 + * 消息类型常量，Number类型，固定值为3，用于创建并发送邮件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + TYPE_EMAIL?: number; + /** + * 创建消息对象 + * 创建指定类型的消息，消息类型可取plus.messaging.TYPE_SMS、plus.messaging.TYPE_MMS、plus.messaging.TYPE_EMAIL。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + createMessage(type : PlusMessaging['TYPE_SMS'] | PlusMessaging['TYPE_MMS'] | PlusMessaging['TYPE_EMAIL']): PlusMessagingMessage; + /** + * 发送消息 + * 发送消息，发送成功回调successCB函数，发送失败回调errorCB函数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + sendMessage(msg: PlusMessagingMessage, successCB?: () => void, errorCB?: (result: any) => void): void; +} + +/** + * 消息对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ +interface PlusMessagingMessage { + /** + * 收件人信息 + * 字符串数组类型，输入的地址收件人信息必须符合消息类型格式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + to?: string []; + /** + * 抄送人信息 + * 字符串数组类型，仅发送邮件时有效，输入的地址收件人信息必须符合消息类型格式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + cc?: string []; + /** + * 暗送人信息 + * 字符串数组类型，仅发送邮件时有效，输入的地址收件人信息必须符合消息类型格式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + bcc?: string []; + /** + * 发件人信息 + * 仅在监听接收到的信息时有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + from?: string; + /** + * 发送消息主题 + * 字符串类型，仅发送邮件时有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + subject?: string; + /** + * 发送消息内容 + * 字符串类型，要发送的消息体内容，其格式必须与bodyType指定的一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + body?: string; + /** + * 发送消息内容类型 + * 要发送消息体内容的类型，可取值"text"表示文本内容，"html"表示为html页面，默认值为"text"。 + * - text/plain: 纯文本类型消息体内容 + * - text/html: 网页数据类型消息体内容(用于发送邮件) + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + bodyType?: 'text/plain' | 'text/html'; + /** + * 是否采用静默方式发送消息 + * 布尔类型，可取值为true或false，true表示静默方式发送，不弹出界面；false表示非静默方式发送。默认采用非静默方式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + silent?: boolean; + /** + * 添加附件 + * 向消息中添加附件，仅邮件类型消息支持，其它类型消息不支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + addAttachment(url: string): void; +} + +/** + * 消息体内容类型 + * 用于设定消息的消息体内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ +interface PlusMessagingBodyType { + /** + * 文本类型 + * 纯文本类型消息体内容，默认消息体内容类型。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + 'text/plain'?: string; + /** + * Html类型 + * 网页数据类型消息体内容，可用于发送邮件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/messaging.html](http://www.html5plus.org/doc/zh_cn/messaging.html) + */ + 'text/html'?: string; +} + +/** + * nativeObj管理系统原生对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObj { + /** + * 原生动画参数 + * 指定动画的类型、持续时间等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + AnimationOptions?: PlusNativeObjAnimationOptions; + /** + * 原生动画窗口样式 + * 指定动画窗口的样式，如背景图片，绘制的文字等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + AnimationViewStyles?: PlusNativeObjAnimationViewStyles; + /** + * 原生图片对象 + * 原生图片对象会占用较大的内存资源，在使用时需谨慎管理，当图片不再使用时应该及时调用clear方法进行销毁。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + Bitmap?: typeof PlusNativeObjBitmap; + /** + * JSON对象，保存图片的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + BitmapSaveOptions?: PlusNativeObjBitmapSaveOptions; + /** + * 原生图片轮播控件对象 + * 原生图片轮播控件对象从原生View控件（plus.nativeObj.View）继承而来，用于绘制图片轮播内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ImageSlider?: typeof PlusNativeObjImageSlider; + /** + * 图片轮播控件样式 + * 从ViewStyles继承而来，扩展支持轮播图片等配置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ImageSliderStyles?: PlusNativeObjImageSliderStyles; + /** + * 图片轮播控件中图片项配置参数 + * 用于指定图片地址等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ImageSliderImageStyles?: PlusNativeObjImageSliderImageStyles; + /** + * 输入框样式 + * 用于定义输入框的显示样式，如字体大小，提示内容等信息。 + * 输入文本内容在指定区域水平居左，垂直居中显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + InputStyles?: PlusNativeObjInputStyles; + /** + * 区域信息对象 + * 包括位置、大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + Rect?: PlusNativeObjRect; + /** + * 绘制区域样式对象 + * 用于定义矩形区域的显示样式，如空心/实心样式、圆角等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + RectStyles?: PlusNativeObjRectStyles; + /** + * 富文本样式 + * 用于定义富文本使用的默认使用的字体名称、字体文件路径等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + RichTextStyles?: PlusNativeObjRichTextStyles; + /** + * 区域信息对象 + * 包括位置、大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + Position?: PlusNativeObjPosition; + /** + * 绘制文本样式对象 + * 用于定义文本的显示样式，如字体大小、字体颜色、字体粗细、字体样式、字体名称等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + TextStyles?: PlusNativeObjTextStyles; + /** + * 原生控件对象 + * 原生控件对象可用于在屏幕上绘制图片或文本内容，当控件不再使用时需要调用close方法销毁控件。 + * NView不支持zindex，后显示的覆盖先显示的； + * 调用Webview窗口对象的append方法添加到Webview中，显示在父窗口所有子Webview的上面；不添加到Webview窗口对象，显示在所有Webview的上面。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + View?: typeof PlusNativeObjView; + /** + * View控件动画参数 + * 指定动画的类型、持续时间等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ViewAnimationOptions?: PlusNativeObjViewAnimationOptions; + /** + * View控件绘制元素参数 + * 指定绘制图片、矩形区域、文本内容等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ViewDrawTagStyles?: PlusNativeObjViewDrawTagStyles; + /** + * View控件事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ViewEvents?: PlusNativeObjViewEvents; + /** + * JSON对象，View控件的系统状态栏区域样式 + * 仅在应用设置为沉浸式状态栏样式下有效，非沉浸式状态栏样式下忽略此属性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ViewStatusbarStyles?: PlusNativeObjViewStatusbarStyles; + /** + * View控件样式 + * 包括位置、大小等信息等，其中位置信息相对于父容器控件进行计算。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + ViewStyles?: PlusNativeObjViewStyles; +} + +/** + * 原生动画参数 + * 指定动画的类型、持续时间等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjAnimationOptions { + /** + * 动画类型 + * 可取值： + * "pop-in" - 从右侧平移入栈动画效果（副窗口从右侧向左平移滑出显示，主窗口从当前屏幕区域向左侧平移滑出被遮盖），如果仅传入一个View控件对象则自动降级为slide-in-right动画； + * "pop-out" - 从右侧平移出栈动画效果（副窗口从当前屏幕区域向右侧平移出可视区域，主窗口从左侧向右平移滑出显示），如果仅出入一个View控件对象则自动降级为slide-out-right动画； + * "slide-in-right" - 从右侧横向滑动效果（主窗口从当前屏幕右侧外向内横向滑动显示）； + * "slide-out-right - 横向向右侧滑出屏幕动画（主窗口从屏幕中横向向右侧滑动到屏幕外）。 + * - pop-in: + * 从右侧平移入栈动画效果（副窗口从右侧向左平移滑出显示，主窗口从当前屏幕区域向左侧平移滑出被遮盖）。 + * + * - pop-out: + * 从右侧平移出栈动画效果（副窗口从当前屏幕区域向右侧平移出可视区域，主窗口从左侧向右平移滑出显示）。 + * + * - slide-in-right: + * 从右侧横向滑动效果（主窗口从当前屏幕右侧外向内横向滑动显示）。 + * + * - slide-out-right: + * 横向向右侧滑出屏幕动画（主窗口从屏幕中横向向右侧滑动到屏幕外）。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + type?: 'pop-in' | 'pop-out' | 'slide-in-right' | 'slide-out-right'; + /** + * 动画持续时间 + * 单位为毫秒，默认值为200ms。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + duration?: number; +} + +/** + * 原生动画窗口样式 + * 指定动画窗口的样式，如背景图片，绘制的文字等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjAnimationViewStyles { + /** + * 动画窗口上绘制的背景图片 + * 图片可以通过Webview对象的draw方法截图，也可以通过Bitmap的API从本地文件中加载。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + bitmap?: PlusNativeObjBitmap; + /** + * 动画窗口上绘制的文本内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + text?: string; + /** + * 动画窗口上绘制的文本样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + textStyles?: PlusNativeObjTextStyles; + /** + * 动画窗口上绘制的文本区域 + * 默认值为{top:'0px',left:'0px',width:'100%',height:'44px'}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + textRect?: PlusNativeObjRect; +} + +/** + * 原生图片对象 + * 原生图片对象会占用较大的内存资源，在使用时需谨慎管理，当图片不再使用时应该及时调用clear方法进行销毁。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +declare class PlusNativeObjBitmap { + /** + * Bitmap对象的标识 + * 在创建Bitmap对象时设置，如果没有设置标识，此属性值为null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + id?: string; + /** + * 静态方法，获取所有Bitmap图片对象 + * 获取应用运行期创建的所有Bitmap图片对象，包含所有空Bitmap对象，不包含已经销毁的Bitmap对象。返回的Bitmap对象在数组中按创建的属性排列，及数组中第一个是最先创建的Bitmap对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + getItems(): PlusNativeObjBitmap []; + /** + * 静态方法，获取指定标识的Bitmap图片对象 + * 在应用中已创建的图片对象中查找指定标识的Bitmap对象并返回。 + * 若存在多个相同标识的Bitmap图片，则返回第一个创建的Bitmap图片。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + getBitmapById(id: string): PlusNativeObjBitmap; + /** + * 销毁Bitmap图片 + * 释放Bitmap图片占用的内存资源，销毁后图片对象将不可使用，其id属性值为undefined，调用其所有方法操作都会失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + clear(): void; + /** + * 加载Bitmap图片 + * 从指定的路径（仅支持本地文件系统）中加载图片，此操作将覆盖之前的图片内容， + * 如果加载图片失败则保留之前的图片内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + load(path: string, successCallback?: () => void, errorCallback?: (result: any) => void): void; + /** + * 加载Base64编码格式图片到Bitmap对象 + * 从Base64编码格式图片数据中加载图片，此操作将覆盖之前的图片内容， + * 如果加载图片失败则保留之前的图片内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + loadBase64Data(data: string, successCallback?: () => void, errorCallback?: (result: any) => void): void; + /** + * 回收Bitmap图片内存 + * 释放Bitmap图片占用的内存资源，但不销毁图片对象，依然可以继续使用图片对象。 + * 当图片对象再次被使用时会自动从设置的路径（构造函数或load/save方法设置）加载到内存中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + recycle(): void; + /** + * 保存图片 + * 将图片保存到指定的路径（仅支持本地文件系统），如果图片为空或者指定的路径文件已经存在则返回失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + save(path: string, options?: PlusNativeObjBitmapSaveOptions, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 获取图片的Base64编码数据 + * 读取图片的数据内容，并转换为Base64编码格式字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + toBase64Data(): string; + /** + * 创建Bitmap对象 + * 创建后为空Bitmap对象，需要调用Webview对象的draw方法更新，或者调用load/loadBase64Data方法加载图片。 + */ + constructor(id?: string, path?: string); +} + +/** + * JSON对象，保存图片的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjBitmapSaveOptions { + /** + * 覆盖保存图片文件 + * 仅在保存的图片路径文件存在时有效： + * true表示覆盖存在的文件； + * false表示不覆盖，如果文件存在，则返回失败。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + overwrite?: boolean; + /** + * 保存图片的格式 + * 支持"jpg"、"png"，如果未指定则默认使用指定的保存路径后缀对应的文件格式，如果后缀文件格式无效则使用jpg格式。 + * - jpg: JPG格式图片 + * - png: PNG格式图片 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + format?: 'jpg' | 'png'; + /** + * 保存图片的质量 + * 取值范围为1-100，1表示使用最低的图片质量（保存后的图片文件最小）、100表示使用最高的图片质量（保存后的图片文件最大）； + * 默认值为50。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + quality?: number; + /** + * 指定裁剪区域保存图片 + * 相对于图片的区域信息，默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + clip?: PlusNativeObjRect; +} + +/** + * 原生图片轮播控件对象 + * 原生图片轮播控件对象从原生View控件（plus.nativeObj.View）继承而来，用于绘制图片轮播内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +declare class PlusNativeObjImageSlider extends PlusNativeObjView { + /** + * 添加图片轮播控件的图片 + * 动态添加图片轮播控件显示的图片。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + addImages(images: PlusNativeObjImageSliderImageStyles []): void; + /** + * 获取当前图片轮播控件显示的图片索引值 + * 索引值从0开始，即0表示图片轮播控件当前显示第一张图片。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + currentImageIndex(): number; + /** + * 设置图片轮播控件的图片 + * 动态更新图片轮播控件显示的图片。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + setImages(images: PlusNativeObjImageSliderImageStyles []): void; + /** + * 创建图片轮播控件对象 + * 与原生View控件一样，创建后需要调用show方法显示，或者添加到Webview中显示。 + */ + constructor(id: string, styles?: PlusNativeObjImageSliderStyles, tags?: PlusNativeObjViewDrawTagStyles []); +} + +/** + * 图片轮播控件样式 + * 从ViewStyles继承而来，扩展支持轮播图片等配置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjImageSliderStyles extends PlusNativeObjViewStyles { + /** + * 是否自动播放 + * 可取值： + * "true" - 自动播放； + * "false" - 不自动播放。 + * 默认值为"false"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + autoplay?: boolean; + /** + * 是否可全屏显示 + * 可取值： + * "true" - 表示可全屏显示，用户点击轮播图片时全屏显示； + * "false" - 表示不可全屏显示，用户点击轮播图片时无响应。 + * 默认值为"true"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + fullscreen?: boolean; + /** + * 是否可循环轮播 + * 可取值： + * "true" - 支持循环轮播； + * "false" - 不支持循环轮播。 + * 默认值为"false"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + loop?: boolean; + /** + * 轮播的图片 + * 至少必须设置一张图片的地址信息，否则可能导致图片轮播控件显示不正常。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + images?: PlusNativeObjImageSliderImageStyles []; + /** + * 自动播放切换时间 + * 当autoplay属性值为true时生效，单位为毫秒。默认值为3000（3秒）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + interval?: number; +} + +/** + * 图片轮播控件中图片项配置参数 + * 用于指定图片地址等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjImageSliderImageStyles { + /** + * 图片地址 + * 支持本地地址（相对地址、绝对路径、RelativeURL、本地路径URL）； + * 也支持网络地址（http://或https://）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + src?: string; + /** + * 图片水平对齐方式 + * 仅在图片显示的宽度与图片轮播控件宽度不一致时有效，可取值： + * "left" - 图片在轮播控件中水平居左对齐； + * "center" - 图片在轮播控件中水平居中对齐； + * "right" - 图片在轮播控件中水平居右对齐。 + * 默认值为"center"。 + * - left: 图片在轮播控件中水平居左对齐 + * - center: 图片在轮播控件中水平居中对齐 + * - right: 图片在轮播控件中水平居右对齐 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + align?: 'left' | 'center' | 'right'; + /** + * 图片显示的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，现对于图片轮播控件的高度； + * 自动计算"auto"，如果指定图片宽度（width），则按图片实际大小等比缩放图片高度值，如果没有指定宽度（width值为"auto"）则自动缩放图片至可完整显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + height?: string; + /** + * 图片显示的宽度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于图片轮播控件的宽度； + * 自动计算"auto"，如果指定图片高度（height），则按图片实际大小等比缩放图片宽度值，如果没有指定高度（height值为"auto"）则自动缩放图片至可完整显示。 + * 默认值为"auto"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + width?: string; + /** + * 图片垂直对齐方式 + * 仅在图片显示的高度与图片轮播控件宽度不一致时有效，可取值： + * "top" - 图片在轮播控件中垂直居顶对齐； + * "middle" - 图片在轮播控件中垂直居中对齐； + * "bottom" - 图片在轮播控件中垂直居底对齐。 + * 默认值为"middle"。 + * - top: 图片在轮播控件中垂直居顶对齐 + * - middle: 图片在轮播控件中垂直居中对齐 + * - bottom: 图片在轮播控件中垂直居底对齐 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + verticalAlign?: 'top' | 'middle' | 'bottom'; +} + +/** + * 输入框样式 + * 用于定义输入框的显示样式，如字体大小，提示内容等信息。 + * 输入文本内容在指定区域水平居左，垂直居中显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjInputStyles { + /** + * 输入框类型 + * 可取值： + * "email" - 邮箱地址输入框； + * "number" - 数字输入框； + * "search" - 搜索文本输入框； + * "tel" - 电话号码输入框； + * "text" - 普通文本输入框； + * "url" - URL地址输入框。 + * 默认为text（即普通文本输入框）。 + * - email: 邮箱地址输入框 + * - number: 数字输入框 + * - search: 搜索文本输入框 + * - tel: 电话号码输入框 + * - text: 普通文本输入框 + * - url: URL地址输入框 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + type?: 'email' | 'number' | 'search' | 'tel' | 'text' | 'url'; + /** + * 输入框的提示文本 + * 当用户未输入内容时显示在编辑框中（灰色文字）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + placeholder?: string; + /** + * 输入框的字体大小 + * 可取值：字体高度像素值，数字加"px"格式字符串，如"12px"。 + * 默认值为"16px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + fontSize?: string; + /** + * 输入框的边框颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色边框。默认值为"#000000"（黑色）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + borderColor?: string; + /** + * 输入框边框圆角半径 + * 可取值：圆角半径像素值，数字加"px"格式字符串，如"6px"。 + * 默认值为"0px"（边框无圆角）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + borderRadius?: string; + /** + * 输入框的边框宽度 + * 可取值：像素值，数字加"px"格式字符串，如"2px"。 默认值为"1px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + borderWidth?: string; + /** + * 输入框完成输入事件 + * 弹出软键盘完成输入后，点击软键盘上的“完成”、“前往”按钮时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + onComplete?: (result: any) => void; + /** + * 输入框获取焦点事件 + * 当编辑框获取焦点时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + onFocus?: (result: any) => void; + /** + * 输入框失去焦点事件 + * 当编辑框失去焦点时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + onBlur?: (result: any) => void; +} + +/** + * 区域信息对象 + * 包括位置、大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjRect { + /** + * 区域左上角的垂直偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于作用对象的高度； + * 自动计算，如"auto",根据height值自动计算，相对于作用对象垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + top?: string; + /** + * 区域左上角的水平偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于作用对象的宽度； + * 自动计算，如"auto",根据width值自动计算，相对于作用对象水平居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + left?: string; + /** + * 区域的宽度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于作用对象的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + width?: string; + /** + * 区域的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于作用对象的高度。 + * 内容自适应，如"wrap_content"，根据内容计算高度（如调用drawText绘制文本时支持）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + height?: string; +} + +/** + * 绘制区域样式对象 + * 用于定义矩形区域的显示样式，如空心/实心样式、圆角等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjRectStyles { + /** + * 绘制颜色 + * 矩形填充区域的颜色，可取值： + * "#RRGGBB"格式字符串，如"#FF0000"表示绘制红色区域； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为"#FFFFFF"（白色）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + color?: string; + /** + * 矩形区域的圆角半径 + * 可取值：圆角半径像素值，数字加"px"格式字符串，如"6px"。 + * 默认值为"0px"（矩形无圆角）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + radius?: string; + /** + * 矩形边框颜色 + * 绘制矩形边框的颜色，可取值： + * "#RRGGBB"格式字符串，如"#FF0000"表示绘制红色区域； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为矩形填充区域颜色（color属性值）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + borderColor?: string; + /** + * 矩形边框宽度 + * 可取值：像素值，数字加"px"格式字符串，如"2px"。 + * 默认值为"0px"（无边框）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + borderWidth?: string; +} + +/** + * 富文本样式 + * 用于定义富文本使用的默认使用的字体名称、字体文件路径等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjRichTextStyles { + /** + * 富文本内容的水平对齐方式 + * 对整体内容有效，无法单独控制每行的内容。 + * 可取值： + * "left"-字体在指定的区域中水平居左对齐； + * "center"-字体在指定的区域中水平居中对齐； + * "right"-字体在指定的区域中水平居右对齐。 + * 默认值为"left"。 + * - left: 富文本内容水平居左对齐 + * - center: 富文本内容水平居中对齐 + * - right: 富文本内容水平居右对齐 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + align?: 'left' | 'center' | 'right'; + /** + * 富文本默认使用的字体名称 + * 例如"Times New Roman"， 如果指定名称的字体不存在，则使用系统默认字体。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + family?: string; + /** + * 富文本默认使用的字体文件路径 + * 加载字体文件路径，必须为本地路径，如果指定的文件路径无效，则使用系统默认字体。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + fontSrc?: string; + /** + * 点击事件回调函数 + * 如果设置此属性，则表示拦截所有RichText上的点击事件（不透传事件）。 + * 如果没有设置此属性，则仅拦截操作包含onclick属性的a/img标签的点击事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + onClick?: (result: any) => void; +} + +/** + * 区域信息对象 + * 包括位置、大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjPosition { + /** + * 区域顶部相对于作用对象（或容器）向下的偏移量 + * 可取值：像素值，如"100px"；百分比，如"10%"，相对于作用对象（或容器）的高度； + * 自动计算，如"auto",根据height值自动计算，相对于作用对象（或容器）垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + top?: string; + /** + * 区域左侧相对于作用对象（或容器）向右的偏移量 + * 可取值：像素值，如"100px"；百分比，如"10%"，相对于作用对象（或容器）的宽度； + * 自动计算，如"auto",根据width值自动计算，相对于作用对象（或容器）水平居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + left?: string; + /** + * 区域的宽度 + * 可取值：像素值，如"100px";百分比，如"10%"，相对于作用对象（或容器）的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + width?: string; + /** + * 区域的高度 + * 可取值：像素值，如"100px";百分比，如"10%"，相对于作用对象（或容器）的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + height?: string; + /** + * 区域底部相对于作用对象（或容器）向上的偏移量 + * 可取值：像素值，如"100px";百分比，如"10%"，相对于作用对象（或容器）的高度。 + * 当设置了top和height值时，忽略此属性值； + * 当未设置top值时，可通过bottom属性值来确定区域的垂直位置； + * 当未设置height值时，可通过top和bottom属性值来确定区域的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + bottom?: string; + /** + * 区域右侧相对于作用对象（或容器）向左的偏移量 + * 可取值：像素值，如"100px";百分比，如"10%"，相对于作用对象（或容器）的宽度。 + * 当设置了left和width值时，忽略此属性值； + * 当未设置left值时，可通过right属性值来确定区域的水平位置； + * 当未设置width值时，可通过left和right属性值来确定区域的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + right?: string; +} + +/** + * 绘制文本样式对象 + * 用于定义文本的显示样式，如字体大小、字体颜色、字体粗细、字体样式、字体名称等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjTextStyles { + /** + * 水平对齐方式 + * 可取值： + * "left"-字体在指定的区域中水平居左对齐； + * "center"-字体在指定的区域中水平居中对齐； + * "right"-字体在指定的区域中水平居右对齐。 + * 默认值为"center"。 + * - left: 字体在指定的区域中水平居左对齐 + * - center: 字体在指定的区域中水平居中对齐 + * - right: 字体在指定的区域中水平居右对齐 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + align?: 'left' | 'center' | 'right'; + /** + * 字体颜色 + * 可取值： + * "#RRGGBB"格式字符串，如"#FF0000"表示绘制红色区域； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为"#000000"（黑色）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + color?: string; + /** + * 文本装饰 + * 可取值： + * "none" - 无装饰效果； + * "underline" - 文本带下划线效果； + * "line-through" - 文本带贯穿线（删除线）效果。 + * 默认值为"none"。 + * - none: + * 无装饰效果 + * + * - underline: + * 文本带下划线效果 + * + * - line-through: + * 文本带贯穿线（删除线）效果 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + decoration?: 'none' | 'underline' | 'line-through'; + /** + * 字体名称 + * 例如"Times New Roman"， 如果指定名称的字体不存在，则使用默认字体。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + family?: string; + /** + * 字体文件路径 + * 加载字体文件路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + fontSrc?: string; + /** + * 文本的行间距 + * 可取值： + * 像素值，如"100px"；百分比，如"10%"，相对于字体的高度（size属性）； + * 默认值为"20%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + lineSpacing?: string; + /** + * 字体的边距 + * 用于设置字体在绘制目标区域四个方向（top/right/bottom/left）的边距，可取值：像素值，如"10px"；百分比，相对于绘制目标区域，如"5%"； + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + margin?: string; + /** + * 文本内容超出显示区域时处理方式 + * 可取值： + * "clip" - 超出显示区域时内容裁剪； + * "ellipsis" - 超出显示区域时尾部显示省略标记（...）。 + * 默认值为"clip"。 + * - clip: + * + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + overflow?: 'clip'; + /** + * 字体大小 + * 可取值：字体高度像素值，数字加"px"格式字符串，如"12px"。 + * 默认值为"16px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + size?: string; + /** + * 字体样式 + * 可取值："normal" - 正常字体样式；"italic" - 斜体样式。默认值为"normal"。 + * - normal: 正常字体样式 + * - italic: 斜体样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + style?: 'normal' | 'italic'; + /** + * 垂直对齐方式 + * 文本内容在指定绘制区域中的垂直对齐方式，可取值： + * "top" - 垂直居顶对齐； + * "middle" - 垂直居中对齐； + * "bottom" - 垂直居底对齐。 + * 默认值为"middle"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + verticalAlign?: string; + /** + * 字体粗细 + * 可取值："normal" - 普通字体；"bold" - 粗字体。默认值为"normal"。 + * - normal: 普通字体 + * - bold: 粗字体 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + weight?: 'normal' | 'bold'; + /** + * 文本换行模式 + * 可取值： + * "nowrap" - 不换行，将所有文本在一行中绘制，忽略换行符("\n")； + * "normal" - 自动换行，当指定的宽度无法绘制所有文本时自动换行绘制，碰到'\n'字符时强制换行。 + * 默认值为"nowrap"。 + * - nowrap: + * 不换行，将所有文本在一行中绘制，忽略换行符("\n") + * + * - normal: + * 自动换行，当指定的宽度无法绘制所有文本时自动换行绘制，碰到'\n'字符时强制换行 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + whiteSpace?: 'nowrap' | 'normal'; +} + +/** + * 原生控件对象 + * 原生控件对象可用于在屏幕上绘制图片或文本内容，当控件不再使用时需要调用close方法销毁控件。 + * NView不支持zindex，后显示的覆盖先显示的； + * 调用Webview窗口对象的append方法添加到Webview中，显示在父窗口所有子Webview的上面；不添加到Webview窗口对象，显示在所有Webview的上面。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +declare class PlusNativeObjView { + /** + * View对象的标识 + * 在创建原生控件View对象时设置，如果没有设置标识，此属性值为null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + id?: string; + /** + * 静态方法，开始原生动画 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + startAnimation(options: PlusNativeObjAnimationOptions, view: PlusNativeObjAnimationViewStyles | PlusNativeObjView, otherview?: PlusNativeObjAnimationViewStyles | PlusNativeObjView, callback?: () => void): void; + /** + * 静态方法，关闭原生动画窗口 + * 通过plus.nativeObj.View.startAnimation方法开始原生动画后，不会自动关闭原生动画窗口对象，需要调用此方法关闭原生动画。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + clearAnimation(type?: 'none'): void; + /** + * 静态方法，获取指定标识的View控件对象 + * 如果存在多个指定id标识的View对象，则返回第一个创建的View控件对象。 + * 如果不存在指定id标识的View对象，则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + getViewById(id: string): PlusNativeObjView; + /** + * 添加事件监听器 + * 向View控件添加事件监听器，当指定的事件发生时，将触发listener函数的执行。 + * 可多次调用此方法向Webview添加多个监听器，当监听的事件发生时，将按照添加的先后顺序执行。 + * 可通过setTouchEventRect方法指定监听触屏操作的区域。 + * 注意：默认View控件拦截处理触屏事件，可调用view.interceptTouchEvent(false)改变为不拦截处理触屏事件（透传）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + addEventListener(event: 'touchstart' | 'touchmove' | 'touchend' | 'click', listener: (result: any) => void, capture?: boolean): void; + /** + * View控件内容动画 + * 动画后可能会导致View控件显示内容改变，可通过调用restore方法恢复。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + animate(options?: PlusNativeObjViewAnimationOptions, callback?: () => void): void; + /** + * 关闭View控件 + * 释放View控件资源，View对象不可再操作，如果View控件已经显示则自动隐藏。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + close(): void; + /** + * 清空矩形区域 + * 清除指定矩形区域内容，透明显示其后面的内容。 + * 可多次调用设置多个区域透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + clearRect(position?: PlusNativeObjPosition, id?: string): void; + /** + * 绘制内容 + * 在当前View控件之上绘制指定的内容，可一次指定绘制多个元素，绘制元素可以是图片/矩形区域/文本， + * 即将多次调用drawBitmap/drawRect/drawText方法合并调用一次draw方法来实现， + * 推荐使用draw方法来替换多次调用drawBitmap/drawRect/drawText。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + draw(tags?: PlusNativeObjViewDrawTagStyles []): void; + /** + * 绘制图片 + * 在当前View控件之上绘制指定的图片，如果图片无效则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + drawBitmap(src: string | PlusNativeObjBitmap, sprite?: PlusNativeObjPosition, position?: PlusNativeObjPosition, id?: string): void; + /** + * 绘制矩形区域 + * 在当前View控件之上绘制指定颜色的矩形区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + drawRect(styles: PlusNativeObjRectStyles | string, position?: PlusNativeObjPosition, id?: string): void; + /** + * 绘制文本 + * 在当前View控件之上绘制指定的文本内容，如果文本为空则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + drawText(text: string, position?: PlusNativeObjPosition, styles?: PlusNativeObjTextStyles, id?: string): void; + /** + * 绘制富文本 + * 在当前View控件之上绘制指定的文本内容，如果文本为空则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + drawRichText(text: string, position?: PlusNativeObjPosition, styles?: PlusNativeObjRichTextStyles, id?: string): void; + /** + * 绘制输入框 + * 在当前View控件之上绘制输入框。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + drawInput(position?: PlusNativeObjPosition, styles?: PlusNativeObjInputStyles, id?: string): void; + /** + * 获取编辑框的焦点状态 + * 通过id查找到指定的编辑框，获取其焦点状态。 + * 如果指定的id无效则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + getInputFocusById(id?: string): boolean; + /** + * 获取编辑框的内容 + * 通过id查找到指定的编辑框，获取其输入的字符串。 + * 如果指定的id无效则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + getInputValueById(id?: string): string; + /** + * 重置view控件显示内容 + * 清除调用drawBitmap、drawText方法绘制的内容，将View控件重置为空内容（透明不可见）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + reset(): void; + /** + * 恢复View控件显示内容 + * 恢复调用animate方法改变View控件的内容，更新至动画前的内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + restore(): void; + /** + * 显示View控件 + * 将View控件显示到屏幕，显示在所有Webview窗口之上。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + show(): void; + /** + * 设置编辑框的焦点状态 + * 通过id查找到指定的编辑框，并设置编辑框的焦点状态。 + * 如果指定的id无效则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + setInputFocusById(id: string, focusable: boolean): string; + /** + * 设置View控件的样式 + * 动态更新View控件样式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + setStyle(styles?: PlusNativeObjViewStyles): void; + /** + * 指定监听触屏事件区域 + * 当调用addEventListener监听View控件事件时，可调用此方法限定监听事件的区域，仅当用户触屏操作在指定区域时才触发监听事件。 + * 非限定监听事件的区域则不拦截，透传给其它窗口处理。 + * 注意：此操作覆盖之前设置的区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + setTouchEventRect(rect?: PlusNativeObjRect [] | PlusNativeObjRect): void; + /** + * 隐藏View控件 + * 将View控件从屏幕隐藏，如果View控件未显示则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + hide(): void; + /** + * 是否拦截View控件的触屏事件 + * 设置为拦截后View控件上的触屏事件不再传递（即不透传），否则触屏事件将继续传递给View控件下的其它窗口处理（即透传）。 + * 注意：View控件默认拦截触屏事件（不透传）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + interceptTouchEvent(intercept?: boolean): void; + /** + * 获取View控件的显示状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + isVisible(): boolean; + /** + * 创建View对象 + * 创建后View对象后，需要调用View对象的show方法显示。 + * 默认显示为无内容样式（背景透明），需要调用drawBitmap/drawText方法更新控件显示的内容。 + */ + constructor(id: string, styles?: PlusNativeObjViewStyles, tags?: PlusNativeObjViewDrawTagStyles []); +} + +/** + * View控件动画参数 + * 指定动画的类型、持续时间等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjViewAnimationOptions { + /** + * 动画类型 + * 可取值："shrink" - 从上到下分块收缩清除窗口动画。 + * - shrink: 从上到下分块清除动画 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + type?: 'shrink'; + /** + * 动画持续时间 + * 单位为毫秒，默认值为200ms。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + duration?: number; + /** + * 动画帧数 + * 必须为大于0的整数，默认值为12。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + frames?: number; + /** + * 动画作用区域 + * 支持以下属性： + * top - 区域距离控件顶部的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的高度）,默认值为'0px'； + * bottom - 区域距离控件底部的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的高度）,默认值为'0px'； + * left - 区域距离控件左侧的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的宽度）,默认值为'0px'； + * right - 区域距离控件右侧的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的宽度）,默认值为'0px'。 + * 如“{top:'44px',bottom:'48px'}”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + region?: PlusNativeObjRect; +} + +/** + * View控件绘制元素参数 + * 指定绘制图片、矩形区域、文本内容等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjViewDrawTagStyles { + /** + * 绘制操作标识 + * 可通过view对象的drawBitmap/drawRect/drawText/clearRect方法进行更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + id?: string; + /** + * 绘制操作类型 + * 可取值： + * "img" - 绘制图片，与drawBitmap操作一致，此时id、src、position、sprite属性值有效； + * "rect" - 绘制矩形区域，与drawRect操作一致，此时id、color、position、rectStyles属性值有效； + * "font" - 绘制文本内容，与drawText操作一致，此时id、position、text、textStyles属性值有效； + * "richtext" - 绘制富文本内容，与drawRichText操作一致，此时id、position、text、richTextStyles属性值有效； + * "input" - 绘制输入框内容，此时id、position、inputStyles属性值有效。 + * - img: 绘制图片 + * - rect: 绘制矩形区域 + * - font: 绘制文本内容 + * - richtext: 绘制富文本内容 + * - input: 绘制输入框内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + tag?: 'img' | 'rect' | 'font' | 'richtext' | 'input'; + /** + * 矩形区域颜色 + * 不推荐使用（推荐使用rectStyles），可取值： + * "#RRGGBB"格式字符串，如红色为"#FF0000"。 + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 当tag属性值为"rect"时有效，用于指定矩形区域颜色，默认值为"#FFFFFF"（白色）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + color?: string; + /** + * 绘制输入框的样式 + * 当tag属性值为"input"时有效，用于指定绘制输入框的样式、大小位置等信息。， + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + inputStyles?: PlusNativeObjInputStyles; + /** + * 绘制内容区域 + * 当tag属性值为"img"时，用于指定绘制图片的目标区域； + * 当tag属性值为"rect"时，用于指定绘制的矩形区域； + * 当tag属性值为"font"时，用于指定绘制文本的目标区域，此时height属性值支持设置为"wrap_content"，表示文本高度根据内容自动计算，此时通过top来定位文本绘制的起始位置。 + * 相对于View控件的区域信息，默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + position?: PlusNativeObjPosition; + /** + * 绘制区域的样式 + * 当tag属性值为"rect"时有效，用于指定绘制区域的样式、填充颜色、圆角大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + rectStyles?: PlusNativeObjRectStyles; + /** + * 绘制的图片资源 + * 当tag属性值为"img"时有效，可以是图片资源路径（字符串类型）或者图片对象（plus.nativeObj.Bitmap对象）。 + * src路径支持gif图片，但设置的图片路径文件使用".gif"后缀时则认为是gif图片，如"_www/loading.gif"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + src?: string; + /** + * 图片源的绘制区域 + * 当tag属性值为"img"时有效，用于指定图片源的绘制区域，相对于图片的区域信息，默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + sprite?: PlusNativeObjPosition; + /** + * 绘制的文本内容 + * 当tag属性值为"font"时有效，用于保存绘制的文本内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + text?: string; + /** + * 绘制文本的样式 + * 当tag属性值为"font"时有效，用于指定绘制文本内容的字体大小、字体颜色、字体类型等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + textStyles?: PlusNativeObjTextStyles; + /** + * 绘制富文本的样式 + * 当tag属性值为"richtext"时有效，用于指定绘制富文本内容的默认字体颜色、字体类型等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + richTextStyles?: PlusNativeObjRichTextStyles; +} + +/** + * View控件事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjViewEvents { + /** + * 双击事件 + * 双击屏幕时触发。 + * 注意：如果将View控件设置为不拦截触屏事件（view.interceptTouchEvent(false)）则不会触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + doubleclick?: string; + /** + * 点击事件 + * 当手指点击屏幕时触发。 + * 注意：如果将View控件设置为不拦截触屏事件（view.interceptTouchEvent(false)）则不会触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + click?: string; + /** + * 开始触屏事件 + * 当手指触摸屏幕时候触发。 + * 注意：如果将View控件设置为不拦截触屏事件（view.interceptTouchEvent(false)）则不会触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + touchstart?: string; + /** + * 触摸滑屏事件 + * 当手指在屏幕上滑动的时候连续地触发。 + * 注意：如果将View控件设置为不拦截触屏事件（view.interceptTouchEvent(false)）则不会触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + touchmove?: string; + /** + * 结束触屏事件 + * 当手指从屏幕上离开的时候触发。 + * 注意：如果将View控件设置为不拦截触屏事件（view.interceptTouchEvent(false)）则不会触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + touchend?: string; +} + +/** + * JSON对象，View控件的系统状态栏区域样式 + * 仅在应用设置为沉浸式状态栏样式下有效，非沉浸式状态栏样式下忽略此属性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjViewStatusbarStyles { + /** + * 系统状态栏区域背景颜色 + * 颜色值格式为"#RRGGBB"，如"#FF0000"表示为红色背景，默认值为应用manifest.json中plus->statusbar->background属性配置的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + background?: string; +} + +/** + * View控件样式 + * 包括位置、大小等信息等，其中位置信息相对于父容器控件进行计算。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ +interface PlusNativeObjViewStyles { + /** + * 区域背景颜色 + * 可取值： + * #RRGGBB"格式字符串，如"#FF0000"表示绘制红色区域； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 默认值为"#FFFFFF"（白色）。 "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 默认值为"#FFFFFF"（白色）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + backgroundColor?: string; + /** + * View控件垂直向上的偏移量 + * 现对于父容器底部的距离，可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父容器的高度，如果没有父容器则相对于屏幕高度。 + * 当设置了top和height值时，忽略此属性值； + * 未设置height值时，可通过top和bottom属性值来确定View控件的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + bottom?: string; + /** + * View控件的停靠方式 + * 仅当View控件添加到Webview窗口对象中并且position属性值设置为"dock"时才生效，此时View控件挤压Webview窗口的大小。 + * 可取值： + * "top"，控件停靠则页面顶部； + * "bottom"，控件停靠在页面底部； + * "right"，控件停靠在页面右侧； + * "left"，控件停靠在页面左侧。 + * 默认值为"top"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + dock?: string; + /** + * 区域的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父容器的高度，如果没有父容器则相对于屏幕高度； + * 内容自适应，如"wrap_content"，根据内容计算控件的高度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + height?: string; + /** + * 区域左上角的水平偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父控件的宽度； + * 自动计算，如"auto"，根据width值自动计算，相对于父控件水平居中。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + left?: string; + /** + * View控件的不透明度 + * 取值范围为0-1，0为全透明，1为不透明，默认值为1，即不透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + opacity?: number; + /** + * View控件的排版方式 + * 仅当View控件添加到Webview窗口对象中时才生效。 + * 可取值： + * "static"，View控件在页面中正常定位，如果页面存在滚动条则随窗口内容滚动； + * "absolute"，Veiw控件在页面中绝对定位，如果页面存在滚动条不随窗口内容滚动； + * "dock"，View控件在页面中停靠，停靠的位置由dock属性值决定。 + * 默认值为"absolute"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + position?: string; + /** + * View控件的状态栏样式 + * 仅在应用设置为沉浸式状态栏样式下有效，设置此属性后将自动保留系统状态栏区域不被View控件占用（即View控件非沉浸式样式显示）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + statusbar?: PlusNativeObjViewStatusbarStyles; + /** + * View控件左上角的垂直偏移量 + * 可取值：像素值，如"100px"；百分比，如"10%"，相对于父控件的高度；自动计算，如"auto",根据height值自动计算，相对于父控件垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + top?: string; + /** + * 区域的宽度 + * 可取值：像素值，如"100px";百分比，如"10%"，相对于父控件的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeobj.html](http://www.html5plus.org/doc/zh_cn/nativeobj.html) + */ + width?: string; +} + +/** + * nativeUI管理系统原生界面，可用于弹出系统原生提示对话框窗口、时间日期选择对话框、等待对话框等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUI { + /** + * 原生选择按钮框上按钮的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + ActionButtonStyles?: PlusNativeUIActionButtonStyles; + /** + * 原生选择按钮框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + ActionSheetStyles?: PlusNativeUIActionSheetStyles; + /** + * 确认对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + ConfirmStyles?: PlusNativeUIConfirmStyles; + /** + * 图片预览的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + PreviewImageStyles?: PlusNativeUIPreviewImageStyles; + /** + * 日期选择对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + PickDateStyles?: PlusNativeUIPickDateStyles; + /** + * 时间选择对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + PickTimeStyles?: PlusNativeUIPickTimeStyles; + /** + * 系统原生界面基类对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + NativeUIObj?: PlusNativeUINativeUIObj; + /** + * 系统等待对话框对象 + * 从NativeUIObj对象继承而来，通过plus.nativeUI.showWaiting方法创建时返回。 + * 用于控制系统样式等待对话框的操作，如关闭、设置标题内容等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + WaitingObj?: PlusNativeUIWaitingObj; + /** + * 原生等待对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + WaitingStyles?: PlusNativeUIWaitingStyles; + /** + * JSON对象，原生等待对话框上loading图标自定义样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + WaitingLoadingStyles?: PlusNativeUIWaitingLoadingStyles; + /** + * 系统提示消息框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + ToastStyles?: PlusNativeUIToastStyles; + /** + * 弹出系统选择按钮框 + * 从底部动画弹出系统样式选择按钮框，可设置选择框的标题、按钮文字等。 + * 弹出的提示框为非阻塞模式，用户点击选择框上的按钮后关闭，并通过actionsheetCallback回调函数通知用户选择的按钮。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + actionSheet(actionsheetStyle: PlusNativeUIActionSheetStyles, actionsheetCallback?: (result: any) => void): PlusNativeUINativeUIObj; + /** + * 弹出系统提示对话框 + * 创建并显示系统样式提示对话框，可设置提示对话框的标题、内容、按钮文字等。 + * 弹出的提示对话框为非阻塞模式，用户点击提示对话框上的按钮后关闭，并通过alertCB回调函数通知对话框已关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + alert(message: string, alertCB?: (result: any) => void, title?: string, buttonCapture?: string): void; + /** + * 弹出系统确认对话框 + * 创建并显示系统样式确认对话框，可设置确认对话框的标题、内容、按钮数目及其文字。 + * 弹出的确认对话框为非阻塞模式，用户点击确认对话框上的按钮后关闭，并通过confirmCB回调函数通知用户点击的按钮索引值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + confirm(message: string, confirmCB?: (result: any) => void, styles?: PlusNativeUIConfirmStyles | string, buttons?: string []): void; + /** + * 关闭系统等待对话框 + * 关闭已经显示的所有系统样式等待对话框，触发Waiting对象的onclose事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + closeWaiting(): void; + /** + * 关闭自动消失的提示消息 + * 关闭已经显示的所有自动消失的提示框。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + closeToast(): void; + /** + * 预览图片 + * 创建并显示全屏图片预览界面，用户点击图片或返回键退出预览界面。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + previewImage(urls: string [], styles?: PlusNativeUIPreviewImageStyles): void; + /** + * 显示系统等待对话框 + * 创建并显示系统样式等待对话框，并返回等待对话框对象Waiting，显示后需调用其close方法进行关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + showWaiting(title?: string, styles?: PlusNativeUIWaitingStyles): PlusNativeUIWaitingObj; + /** + * 弹出系统日期选择对话框 + * 创建并显示系统样式日期选择对话框，可进行日期的选择。 + * 用户操作确认后通过successCB回调函数返回用户选择的日期，若用户取消选择则通过errorCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + pickDate(successCB: (result: any) => void, errorCB?: (result: any) => void, styles?: PlusNativeUIPickDateStyles): void; + /** + * 弹出系统时间选择对话框 + * 创建并弹出系统样式时间选择对话框，可进行时间的选择。 + * 用户操作确认后通过successCB回调函数返回用户选择的时间，若用户取消选择则通过errorCB回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + pickTime(successCB: (result: any) => void, errorCB?: (result: any) => void, styles?: PlusNativeUIPickTimeStyles): void; + /** + * 弹出系统输入对话框 + * 创建并显示系统样式输入对话框，可设置输入对话框的标题、内容、提示输入信息、按钮数目及其文字。 + * 弹出的输入对话框为非阻塞模式，其中包含编辑框供用户输入内容，用户点击输入对话框上的按钮后自动关闭，并通过promptCB回调函数返回用户点击的按钮及输入的内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + prompt(message: string, promptCB?: (result: any) => void, title?: string, tip?: string, buttons?: string []): void; + /** + * 显示自动消失的提示消息 + * 创建并显示系统样式提示消息，弹出的提示消息为非阻塞模式，显示指定时间后自动消失。 + * 提示消息显示时间可通过styles的duration属性控制，长时间提示消息显示时间约为3.5s，短时间提示消息显示时间约为2s。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + toast(message: string, styles?: PlusNativeUIToastStyles): void; + /** + * 设置原生界面样式（暗黑模式） + * iOS13+系统支持暗黑模式，可设置原生界面的外观样式为浅色或深色（暗黑模式）。 + * 即使应用没有设置"全局开启暗黑模式"，也可以调用此方法强制设置原生界面外观样式。 + * HBuilderX2.6.3+版本支持，并且要求iOS13及以上系统。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + setUIStyle(style: 'light' | 'dark' | 'auto'): void; +} + +/** + * 原生选择按钮框上按钮的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIActionButtonStyles { + /** + * 按钮上的文字颜色 + * 可取值： + * "#RRGGBB"格式字符串，如"#FF0000"表示文字颜色为红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + color?: string; + /** + * 按钮上的文字内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + title?: string; + /** + * 按钮的样式 + * 可取值： + * "destructive" - 表示警示按钮样式，默认文字颜色为红色； + * "default" - 表示默认按钮样式。 + * 默认值为"default"。 + * - destructive: + * 警示按钮样式。 + * + * - default: + * 默认按钮样式。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + style?: 'destructive' | 'default'; +} + +/** + * 原生选择按钮框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIActionSheetStyles { + /** + * 选择按钮框的标题 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + title?: string; + /** + * 取消按钮上显示的文字内容 + * 不设置此属性，则不显示取消按钮。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + cancel?: string; + /** + * 选择框上的按钮 + * ActionButtonStyles对象数组 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + buttons?: PlusNativeUIActionButtonStyles []; + /** + * 弹出原生选择按钮框的指示区域 + * JSON类型对象，格式如{top:10;left:10;width:200;height:200;}，所有值为像素值，其值为相对于容器Webview的位置。 + * 如未设置此值，默认指向屏幕底部水平居中位置。 + * 注意：HBuilderX2.6.6+版本支持，仅在iPad上有效，其它设备忽略此值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + popover?: any; +} + +/** + * 确认对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIConfirmStyles { + /** + * 确认对话框显示的标题 + * 如果不设置此属性值，则不显示标题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + title?: string; + /** + * 确认对话框上显示的按钮 + * 字符串数组，每项对应在确认对话框上显示一个按钮，用户点击后通过confirmCB返回用户点击按钮的在数组中的索引值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + buttons?: string []; + /** + * 对话框在屏幕中的垂直分享对齐方式 + * 可取值： + * "top" - 表示垂直居顶对齐； + * "center" - 表示垂直居中对齐； + * "bottom" - 表示垂直居底对齐。 + * 默认值为"center"（垂直居中对齐）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + verticalAlign?: string; +} + +/** + * 图片预览的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIPreviewImageStyles { + /** + * 图片预览的背景颜色 + * 颜色值格式为"#RRGGBB"，如"#FF0000"表示为红色背景。 + * 默认值为黑色（"#000000"）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + background?: string; + /** + * 默认显示图片的索引值 + * 索引值从0开始，默认值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + current?: number; + /** + * 图片指示器样式 + * 可取值： + * "default" - 默认指示器（底部圆点样式）； + * "number" - 顶部数字指示器（顶部居中显示，文字为%当前图片索引值（从1开始）%/%图片总数%）； + * "none" - 不显示指示器。 + * 默认值为"default"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + indicator?: string; + /** + * 是否可循环预览 + * 可取值： + * "true" - 支持循环预览； + * "false" - 不支持循环预览。 + * 默认值为"false"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + loop?: boolean; + /** + * 长按事件 + * 用户在图片预览界面长按时触发。 + * 在回调中返回长按图片的信息（索引值、地址等）。 + * 由于图片预览界面是层级非常高的窗口，此时只能调用plus.nativeUI.*显示的窗口覆盖在图片预览界面上（原生控件plus.nativeObj.View也无法显示）。 + * 注意：HBuilderX1.9.5及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + onLongPress?: (result0: number, result1: string, result2: string) => void; +} + +/** + * 日期选择对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIPickDateStyles { + /** + * 日期选择对话框显示的标题 + * 如果未设置，则不显示标题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + title?: string; + /** + * 日期选择对话框默认显示的日期 + * 如果未设置，则显示当前的日期。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + date?: Date; + /** + * 日期选择对话框可选择的最小日期 + * Date类型对象，如果未设置可选择的最小日期，则使用系统默认可选择的最小日期值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + minDate?: Date; + /** + * 日期选择对话框可选择的最大日期 + * Date类型对象，如果未设置可选择的最大日期，则使用系统默认可选择的最大日期值。 + * 其值必须大于minDate设置的值，否则使用系统默认可选择的最大日期值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + maxDate?: Date; + /** + * 时间选择对话框弹出指示区域 + * JSON类型对象，格式如{top:10;left:10;width:200;height:200;}，所有值为像素值，其值为相对于容器Webview的位置。 + * 如未设置此值，默认在屏幕居中显示。仅在iPad上有效，其它设备忽略此值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + popover?: any; +} + +/** + * 时间选择对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIPickTimeStyles { + /** + * 时间选择对话框默认显示的时间 + * 如果未设置，则默认当前的时间。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + time?: Date; + /** + * 时间选择对话框显示的标题 + * 如果未设置，则不显示标题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + title?: string; + /** + * 是否24小时制模式 + * true表示使用24小时制模式显示，fale表示使用12小时制模式显示，默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + is24Hour?: boolean; + /** + * 日期选择对话框弹出指示区域 + * JSON类型对象，格式如{top:10;left:10;width:200;height:200;}，所有值为像素值，其值相对于容器webview的位置。 + * 如未设置此值，默认在屏幕居中显示。仅在iPad上有效，其它设备忽略此值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + popover?: any; +} + +/** + * 系统原生界面基类对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUINativeUIObj { + /** + * 关闭显示的系统原生界面 + * 调用plus.nativeUI.actionSheet方法创建并显示系统界面后，可通过其close方法将原生界面关闭。 + * 此情况下触发界面关闭回调函数参数的index属性值为-1。 + * 注意：一个系统原生界面只能关闭一次，多次调用将无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + close(): void; +} + +/** + * 系统等待对话框对象 + * 从NativeUIObj对象继承而来，通过plus.nativeUI.showWaiting方法创建时返回。 + * 用于控制系统样式等待对话框的操作，如关闭、设置标题内容等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIWaitingObj { + /** + * 等待对话框关闭事件 + * 等待框关闭时触发，当调用close方法或用户点击返回按钮导致等待框关闭时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + onclose?: () => void; + /** + * 设置等待对话框上显示的文字内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + setTitle(title: string): void; + /** + * 关闭显示的系统等待对话框 + * 调用plus.nativeUI.showWaiting方法创建并显示系统等待界后，可通过其close方法将原生等待控件关闭。 + * 一个系统等待对话框只能关闭一次，多次调用将无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + close(): void; +} + +/** + * 原生等待对话框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIWaitingStyles { + /** + * 等待框背景区域的宽度 + * 值支持像素值（"500px"）或百分比（"50%"），百分比相对于屏幕的宽计算，如果不设置则根据内容自动计算合适的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + width?: string; + /** + * 等待框背景区域的高度 + * 值支持像素绝对值（"500px"）或百分比（"50%"），如果不设置则根据内容自动计算合适的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + height?: string; + /** + * 等待框中文字的颜色 + * 颜色值支持(参考CSS颜色规范)：颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值，默认值为白色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + color?: string; + /** + * 等待框中文字的字体大小 + * 如"14px"表示使用14像素高的文字，未设置则使用系统默认字体大小。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + size?: string; + /** + * 等待对话框中标题文字的水平对齐方式 + * 对齐方式可选值包括："left"：水平居左对齐显示，"center"：水平居中对齐显示，"right"：水平居右对齐显示。默认值为水平居中对齐显示，即"center"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + textalign?: string; + /** + * 等待对话框的内边距 + * 值支持像素值（"10px"）和百分比（"5%"），百分比相对于屏幕的宽计算，默认值为"3%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + padding?: string; + /** + * 等待对话框显示区域的背景色 + * 背景色的值支持(参考CSS颜色规范)：颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值，默认值为rgba(0,0,0,0.7)。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + background?: string; + /** + * 等待对话框样式 + * 可取值"black"、"white"，black表示等待框为黑色雪花样式，通常在背景主色为浅色时使用；white表示等待框为白色雪花样式，通常在背景主色为深色时使用。 + * 仅在iOS平台有效，其它平台忽略此值，未设置时默认值为white。 + * - black: 黑色雪花样式，适合浅色界面使用 + * - white: 白色雪花样式，适合深色界面使用 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + style?: 'black' | 'white'; + /** + * 等待框是否模态显示 + * 模态显示时用户不可操作直到等待对话框关闭，否则用户在等待对话框显示时也可操作下面的内容，未设置时默认为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + modal?: boolean; + /** + * 等待框显示区域的圆角 + * 值支持像素值（"10px"），未设置时使用默认值"10px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + round?: number; + /** + * 点击等待显示区域是否自动关闭 + * true表示点击等待对话框显示区域时自动关闭，false则不关闭，未设置时默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + padlock?: boolean; + /** + * 返回键处理方式 + * 可取值"none"表示截获处理返回键，但不做任何响应；"close"表示截获处理返回键并关闭等待框；"transmit"表示不截获返回键，向后传递给Webview窗口继续处理（与未显示等待框的情况一致）。 + * - none: 截获返回键，不做任何响应 + * - close: 截获返回键并关闭等待框 + * - transmit: 不截获返回键，继续传递给Webview窗口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + back?: 'none' | 'close' | 'transmit'; + /** + * 自定义等待框上loading图标样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + loading?: PlusNativeUIWaitingLoadingStyles; +} + +/** + * JSON对象，原生等待对话框上loading图标自定义样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIWaitingLoadingStyles { + /** + * loading图标显示样式 + * 可取值： + * "block"表示图标与文字分开两行显示，上面显示loading图标，下面显示文字； + * "inline"表示loading图标与文字在同一行显示，左边显示loading图标，右边显示文字； + * "none"表示不显示loading图标； + * - block: + * loading图标与文字分开两行显示，上面显示loading图标，下面显示文字。 + * + * - inline: + * loading图标与文字在同一行显示，左边显示loading图标，右边显示文字。 + * + * - none: + * 不显示loading图标。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + display?: 'block' | 'inline' | 'none'; + /** + * loading图标高度 + * 设置loading图标的高度（宽度等比率缩放），取值类型：像素值，如"14px"表示14像素高。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + height?: string; + /** + * loading图标路径 + * 自定义loading图标的路径，png格式，并且必须是本地资源地址； + * loading图要求宽是高的整数倍，显示等待框时按照图片的高横向截取每帧刷新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + icon?: string; + /** + * loading图每帧刷新间隔 + * 单位为ms（毫秒），默认值为100ms。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + interval?: number; + /** + * loading图标类型 + * 如果设置了icon属性，则优先使用icon自定义图标。 + * 可取值： + * "circle" - 圆圈类型loading图标； + * "snow" - 雪花类型loading图标。 + * 默认值为"circle"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + type?: string; +} + +/** + * 系统提示消息框的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ +interface PlusNativeUIToastStyles { + /** + * 提示消息框在屏幕中的水平位置 + * 可选值为"left"、"center"、"right"，分别为水平居左、居中、居右，未设置时默认值为"center"。 + * - left: 水平居左对齐 + * - center: 水平居中对齐 + * - right: 水平居左对齐 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + align?: 'left' | 'center' | 'right'; + /** + * 提示消息框的背景色 + * 背景色的值支持(参考CSS颜色规范)：颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + background?: string; + /** + * 提示消息框显示的时间 + * 可选值为"long"、"short"，值为"long"时显示时间约为3.5s，值为"short"时显示时间约为2s，未设置时默认值为"short"。 + * - long: 长显示时间 + * - short: 短显示时间 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + duration?: 'long' | 'short'; + /** + * 提示消息框上显示的图标 + * 仅支持本地图片路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + icon?: string; + /** + * 图标的宽度 + * 单位为px（逻辑像素值），默认值为图片的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + iconWidth?: string; + /** + * 图标的高度 + * 单位为px（逻辑像素值），默认值为图片的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + iconHeight?: string; + /** + * 提示消息框上显示的样式 + * 可取值： + * "block" - 表示图标与文字分两行显示，上面显示图标，下面显示文字； + * "inline" - 表示图标与文字在同一行显示，左边显示图标，右边显示文字。 + * 默认值为"block"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + style?: string; + /** + * 提示消息框上显示的文本类型 + * 可取值： + * "text" - 显示的消息内容为文本字符串； + * "richtext" - 显示的消息内容为富文本内容。 + * 默认值为"text"。 + * 当type为"text"时，富文本使用html的部分标签，具体标签如下： + * 图片标签<img src="图片资源url地址" width="图片显示的宽度" height="图片显示的高度" onclick="console.log('clicked img')"></img>； + * 字体标签<font color="字体颜色"></font>，内容在一行显示不下时自动换行，行高默认为字体的1.2倍； + * 换行标签<br/>； + * 链接标签<a onclick="console.log('clicked a')">链接地址</a>。 + * 如示例“<img onclick="console.log('clicked img')" src="http://img-cdn-qiniu.dcloud.net.cn/icon2.png"/><a onclick="console.log(clicked a)">链接地址</a>”。 + * - text: 文本字符串 + * - richtext: 富文本内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + type?: 'text' | 'richtext'; + /** + * 富文本样式 + * 当type属性值为"richtext"时有效，用于定义富文本的样式，如其文本对齐方式、使用的字体等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + richTextStyle?: PlusNativeObjRichTextStyles; + /** + * 提示消息在屏幕中的垂直位置 + * 可选值为"top"、"center"、"bottom"，分别为垂直居顶、居中、居底，未设置时默认值为"bottom"。 + * - top: 垂直居顶对齐 + * - center: 垂直居中对齐 + * - bottom: 垂直居底对齐 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/nativeui.html](http://www.html5plus.org/doc/zh_cn/nativeui.html) + */ + verticalAlign?: 'top' | 'center' | 'bottom'; +} + +/** + * navigator用于管理浏览器运行环境信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ +interface PlusNavigator { + /** + * 创建应用快捷方式要设置的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + ShortcutOptions?: PlusNavigatorShortcutOptions; + /** + * 更新应用启动界面要设置的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + SplashscreenOptions?: PlusNavigatorSplashscreenOptions; + /** + * 运行环境权限类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + PermissionNames?: PlusNavigatorPermissionNames; + /** + * JSON对象，安全区域信息对象 + * 通过getSafeAreaInsets方法返回的信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + SafeAreaInsets?: PlusNavigatorSafeAreaInsets; + /** + * 检查运行环境的权限 + * 向系统检查当前程序的权限状态，不触发权限相对应的功能API的调用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + checkPermission(permission?: PlusNavigatorPermissionNames): string; + /** + * 关闭应用启动界面 + * 很多情况下，应用启动后需要一段时间加载数据，为了避免界面显示空白内容，提高用户体验效果，这时可显示启动界面。 + * 等数据加载完成后再关闭启动界面进入应用，通常可在应用首界面加载数据完成并更新显示内容后调用此方法。 + * 注意：HBuilder7.1版本后启动界面不调用此方法超过6秒后会自动关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + closeSplashscreen(): void; + /** + * 查询设备是否为刘海屏 + * 刘海屏返回true，否则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + hasNotchInScreen(): boolean; + /** + * 查询应用启动界面是否已关闭 + * 如果启动界面显示返回true，否则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + hasSplashscreen(): boolean; + /** + * 更新程序启动界面 + * 可设置启动界面显示的图片（仅支持本地文件路径，如果是网络资源可先通过plus.downloader.*下载到本地）， + * 更新启动界面后程序下次启动时生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + updateSplashscreen(options?: PlusNavigatorSplashscreenOptions): void; + /** + * 创建应用快捷方式 + * 在系统桌面创建应用的快捷方式，点击后可直接启动应用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + createShortcut(options?: PlusNavigatorShortcutOptions, successCallback?: (result: any) => void): void; + /** + * 查询是否存在应用快捷方式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + hasShortcut(options?: PlusNavigatorShortcutOptions, successCallback?: (result: any) => void): void; + /** + * 隐藏系统虚拟按键（导航栏） + * HBuilderX2.3.4及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + hideSystemNavigation(): void; + /** + * 显示系统虚拟按键（导航栏） + * HBuilderX3.0.0及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + showSystemNavigation(): void; + /** + * 判断当前应用是否切换到后台 + * 在多应用运行环境（如流应用）中，启动一个新应用时，之前运行的应用将会自动切换到后台运行，此时plus.navigator.isBackground()返回状态只为true。 + * 注意：此状态不是5+应用切换到系统后台的状态，而是在同一apk中同时运行多个应用时被切换到后台的状态。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + isBackground(): boolean; + /** + * 判断应用当前是否全屏模式显示 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + isFullscreen(): boolean; + /** + * 判断应用当前是否输出日志 + * 日志包括应用原生层内部跟踪日志（ADB、LogCat工具可获取的日志）及JS层跟踪日志（console.log输出的日志）。 + * 开启日志在一定程度上会降低程序的性能，通常建议在正式发布时关闭日志输出，在调试时开启日志输出（此时可以通过工具ADB、LogCat获取分析日志）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + isLogs(): boolean; + /** + * 判断当前设备是否被root破解 + * 注意：HBuilderX3.0.0及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + isRoot(): boolean; + /** + * 判断当前应用是否运行在模拟器中 + * 注意：HBuilderX3.0.0及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + isSimulator(): boolean; + /** + * 设置应用是否全屏显示 + * 设置应用在全屏模式显示时，将隐藏系统状态栏，通常游戏类应用才会设置为全屏模式显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + setFullscreen(fullscreen: boolean): void; + /** + * 设置应用是否输出日志 + * 设置应用是否输出日志信息，默认关闭输出日志功能。 + * 日志包括应用原生层内部跟踪日志（ADB、LogCat工具可获取的日志）及JS层跟踪日志（console.log输出的日志）。 + * 开启日志在一定程度上会降低程序的性能，通常建议在正式发布时关闭日志输出，在调试时开启日志输出（此时可以通过工具ADB、LogCat获取分析日志）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + setLogs(log: boolean): void; + /** + * 设置系统状态栏背景颜色 + * 设置应用在前台运行时系统状态栏的背景颜色，默认使用系统状态栏默认背景色（由系统状态栏样式及应用的主题决定）。 + * 通常系统状态栏的前景色为白色或黑色，所以避免设置接近白色或黑色的颜色值。 + * 注意：如果应用设置为沉浸式状态栏样式，则无法设置状态栏的背景颜色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + setStatusBarBackground(color: string): void; + /** + * 获取系统状态栏背景颜色 + * 获取应用在前台运行时系统状态栏的背景颜色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getStatusBarBackground(): string; + /** + * 设置系统状态栏样式 + * 设置应用在前台运行时系统状态栏的样式，默认值可通过manifest.json文件的plus->statusbar->style配置。 + * 注意：此操作是应用全局配置，调用的Webview窗口关闭后仍然生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + setStatusBarStyle(style: 'dark' | 'light'): void; + /** + * 获取系统状态栏样式 + * 获取应用运行时系统状态栏的样式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getStatusBarStyle(): string; + /** + * 获取系统状态栏高度 + * 单位为像素（px），值为Webview中的逻辑高度单位，如果要获取真实高度则必须乘以plus.screen.scale。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getStatusbarHeight(): number; + /** + * 判断当前是否为沉浸式状态栏模式 + * 如果当前应用采用沉浸式状态栏则返回true，否则返回false。 + * 注意：如果当前系统版本不支持沉浸式状态栏也返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + isImmersedStatusbar(): boolean; + /** + * 设置userAgent值 + * 设置应用通过navigator.userAgent获取的值，及所有发起Http请求时提交的userAgent值。 + * 如果要设置启动页面的userAgent值则需要在manifest.json中进行配置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + setUserAgent(useragent: string, checkplus?: boolean): void; + /** + * 获取userAgent值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getUserAgent(): string; + /** + * 设置Cookie值 + * 设置应用发起Http请求时提交的cookie值，调用此接口后所有的请求都生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + setCookie(url: string, value: string): void; + /** + * 获取Cookie值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getCookie(url: string): string; + /** + * 删除应用所有Cookie值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + removeAllCookie(): void; + /** + * 删除应用Cookie + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + removeCookie(url: string): void; + /** + * 删除应用所有会话期Cookie值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + removeSessionCookie(): void; + /** + * 获取应用的安全区域 + * 可在应用manifest.json的plus->safeArea下配置应用的全局安全区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getSafeAreaInsets(): PlusNavigatorSafeAreaInsets; + /** + * 获取应用的横竖屏状态 + * 返回应用当前的横竖屏状态，如果应用横竖屏发生转换，需重新获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getOrientation(): number; + /** + * 获取系统外观样式（暗黑模式） + *

+ * 返回当前系统使用的外观样式，用于判断是否设置为暗黑模式。 + * 可通过uistylechange事件监听外观样式的变化。 + * HBuilderX2.6.3+版本支持，iOS平台适配暗黑模式参考：https://ask.dcloud.net.cn/article/36995。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getUIStyle(): string; + /** + * 获取应用的签名标识 + *

+ * 签名标识可以认为是应用的身份信息，可以用来判断应用是否被反编译重新签名再发布。 + * 注意：HBuilderX3.0.0及以上版本支持 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + getSignature(): string; +} + +/** + * 创建应用快捷方式要设置的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ +interface PlusNavigatorShortcutOptions { + /** + * 快捷方式名称 + * 如果未设置则使用应用的名称，manifest.json中name属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + name?: string; + /** + * 快捷方式的图标 + * 如果未设置则优先使用应用中指定的图标（manifest.json中icon节点下对应分辨率的图标），如未区配则使用应用的图标（仅在独立打包时），否则使用runtime提供的默认图标。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + icon?: string; + /** + * 创建快捷方式后的提示信息 + * 快捷方式创建成功后显示，默认提示内容为“"XXXX"已创建桌面快捷方式”，其中"XXXX"为程序的名称，如果不需要提示则设置此值为空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + toast?: string; + /** + * 快捷方式的扩展参数 + * 其中key和value值都必须是字符串类型。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + extra?: any; + /** + * 要启动Activity类名 + * 通常情况下不需要指定此值，仅在5+SDK集成时自定义Activity才用到。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + classname?: string; + /** + * 是否需要强制创建快捷方式 + * true表示强制创建，false表示不强制创建，默认值为true。 + * 强制创建可能会导致在无法判断快捷方式是否存在的设备上重复创建，如果需要尽可能避免出现重复创建桌面快捷方式则应该设置force属性值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + force?: boolean; +} + +/** + * 更新应用启动界面要设置的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ +interface PlusNavigatorSplashscreenOptions { + /** + * 启动界面的图片路径 + * 仅支持本地文件路径，图片必须为png格式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + image?: string; + /** + * 是否自动关闭启动界面 + * true表示应用启动后自动关闭启动界面，false表示应用启动后不自动关闭启动界面，需要在应用调用plus.navigator.closeSplashscreen()方法关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + autoclose?: boolean; + /** + * 是否自动关闭启动界面（WAP2APP应用） + * 与autoclose属性值作用一致，仅在WAP2APP应用中有效。 + * 不推荐设置此值，如果未设置会自动使用autoclose属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + autoclose_w2a?: boolean; + /** + * 启动界面延时关闭时间 + * 仅在设置为自动关闭启动界面时有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + delay?: number; + /** + * 启动界面延时关闭时间（WAP2APP应用） + * 与delay属性值作用一致，仅在WAP2APP应用中有效。 + * 不推荐设置此值，如果未设置会自动使用delay属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + delay_w2a?: number; +} + +/** + * 运行环境权限类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ +interface PlusNavigatorPermissionNames { + /** + * 访问摄像头权限 + * 用于调用摄像头（plus.camera.*、plus.barcode.*）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + CAMERA?: string; + /** + * 访问系统联系人权限 + * 用于访问（读、写）系统通讯录（plus.gallery.*）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + CONTACTS?: string; + /** + * 访问系统相册权限 + * 用于访问（读、写）系统相册（plus.gallery.*）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + GALLERY?: string; + /** + * 定位权限 + * 用于获取当前用户位置信息（plus.geolocation.*）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + LOCATION?: string; + /** + * 消息通知权限 + * 用于接收系统消息通知（plus.push.*）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + NOTIFITION?: string; + /** + * 录音权限 + * 用于进行本地录音操作（plus.audio.AudioRecorder）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + RECORD?: string; + /** + * 创建桌面快捷方式权限 + * 用于在系统桌面创建快捷方式图标（plus.navigator.createShortcut）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + SHORTCUT?: string; +} + +/** + * JSON对象，安全区域信息对象 + * 通过getSafeAreaInsets方法返回的信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ +interface PlusNavigatorSafeAreaInsets { + /** + * 应用底部安全区域偏移量 + * 单位为逻辑像素（px）， 如果应用已经配置底部安全区域则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + bottom?: number; + /** + * 应用左侧安全区域偏移量 + * 单位为逻辑像素（px）， 如果应用已经配置左侧安全区域则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + left?: number; + /** + * 应用右侧安全区域偏移量 + * 单位为逻辑像素（px）， 如果应用已经配置右侧安全区域则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + right?: number; + /** + * 应用顶部安全区域偏移量 + * 单位为逻辑像素（px）， 如果应用已经配置顶部安全区域则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + top?: number; + /** + * 设备底部安全区域偏移量 + * 单位为逻辑像素（px）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + deviceBottom?: number; + /** + * 设备左侧安全区域偏移量 + * 单位为逻辑像素（px）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + deviceLeft?: number; + /** + * 设备右侧安全区域偏移量 + * 单位为逻辑像素（px）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + deviceRight?: number; + /** + * 设备顶部安全区域偏移量 + * 单位为逻辑像素（px）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/navigator.html](http://www.html5plus.org/doc/zh_cn/navigator.html) + */ + deviceTop?: number; +} + +/** + * Orientation模块管理设备的方向信息，包括alpha、beta、gamma三个方向信息，通过plus.orientation可获取设备方向管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ +interface PlusOrientation { + /** + * JSON对象，监听设备方向感应器参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + OrientationOption?: PlusOrientationOrientationOption; + /** + * JSON对象，设备方向信息数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + Rotation?: PlusOrientationRotation; + /** + * 获取当前设备的方向信息，包括alpha、beta、gamma三个方向信息 + * 方向信息是设备相对于水平初始方向分别以z、x、y轴为轴心旋转的角度，对应值为alpha、beta、gamma三个方向的信息。 方向信息可通过successCB回调函数返回。方向信息获取失败则调用回调函数errorCB + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + getCurrentOrientation(successCB: (result: PlusOrientationRotation) => void, errorCB?: (result: any) => void): void; + /** + * 监听设备方向信息的变化 + * 方向信息是设备相对于水平初始方向分别以z、x、y轴为轴心旋转的角度，对应值为alpha、beta、gamma三个方向的信息。watchOrientation每隔固定时间就获取一次设备的方向信息，通过successCB回调函数返回。可通过option的frequency参数设定获取设备方向信息的时间间隔。方向信息获取失败则调用回调函数errorCB。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + watchOrientation(successCB: (result: PlusOrientationRotation) => void, errorCB?: (result: any) => void, option?: PlusOrientationOrientationOption): number; + /** + * 关闭监听设备方向信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + clearWatch(watchId: number): void; +} + +/** + * JSON对象，监听设备方向感应器参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ +interface PlusOrientationOrientationOption { + /** + * 更新方向信息的时间间隔 + * 数值类型，单位为ms，默认值为500ms。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + frequency?: number; +} + +/** + * JSON对象，设备方向信息数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ +interface PlusOrientationRotation { + /** + * 以z方向为轴心的旋转角度 + * 浮点数类型，只读属性，取值范围为0到360（不等于360）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + alpha?: number; + /** + * 以x方向为轴心的旋转角度 + * 浮点数类型，只读属性，取值范围为-180到180（不等于180）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + beta?: number; + /** + * 以y方向为轴心的旋转角度 + * 浮点数类型，只读属性，取值范围为-180到180（不等于180）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + gamma?: number; + /** + * 设备方向与地球磁场北极方向的角度 + * 浮点数类型，只读属性，取值范围为0到360（不等于360）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + magneticHeading?: number; + /** + * 设备方向与地球真实北极方向的角度 + * 浮点数类型，只读属性，取值范围为0到360（不等于360）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + trueHeading?: number; + /** + * 设备方向值的误差值 + * 浮点数类型，只读属性，取值范围为0到360（不等于360）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/orientation.html](http://www.html5plus.org/doc/zh_cn/orientation.html) + */ + headingAccuracy?: number; +} + +/** + * Proximity模块管理设备距离传感器，可获取当前设备的接近距离信息，通过plus.proximity可获取设备距离传感管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/proximity.html](http://www.html5plus.org/doc/zh_cn/proximity.html) + */ +interface PlusProximity { + /** + * 获取当前设备的接近距离信息 + * 获取当前接近设备的距离信息，距离值单位为厘米。如果感应器无法获取准确的距离值，则在接近设备时返回0，否则返回Infinity。 获取成功则调用successCB回调函数返接近回距离值。获取失败则调用errorCB回调函数错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/proximity.html](http://www.html5plus.org/doc/zh_cn/proximity.html) + */ + getCurrentProximity(successCB: (result: number) => void, errorCB?: (result: any) => void): void; + /** + * 监听设备接近距离的变化 + * watchProximity将监听设备的接近距离信息变化事件，当接近距离发生变化时通过changeCB回调函数返回距离值。监听距离变化事件失败则通过errorCB回调函数返回错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/proximity.html](http://www.html5plus.org/doc/zh_cn/proximity.html) + */ + watchProximity(changeCB: (result: number) => void, errorCB?: (result: any) => void): number; + /** + * 关闭监听设备接近距离变化 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/proximity.html](http://www.html5plus.org/doc/zh_cn/proximity.html) + */ + clearWatch(watchId: number): void; +} + +/** + * Runtime模块管理运行环境，可用于获取当前运行环境信息、与其它程序进行通讯等。通过plus.runtime可获取运行环境管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ +interface PlusRuntime { + /** + * JSON对象，打开第三方程序参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + ApplicationInf?: PlusRuntimeApplicationInf; + /** + * JSON对象，应用角标显示需要的通知栏消息的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + BadgeOptions?: PlusRuntimeBadgeOptions; + /** + * JSON对象，打开文件参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + OpenFileOptions?: PlusRuntimeOpenFileOptions; + /** + * JSON对象，应用信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + WidgetInfo?: PlusRuntimeWidgetInfo; + /** + * JSON对象，应用安装参数 + * 可通过对象设置安装的应用是否进行appid校验、版本号校验等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + WidgetOptions?: PlusRuntimeWidgetOptions; + /** + * 当前应用的APPID + * 当前应用的APPID，字符串类型。注意，如果是在HBuilder真机运行获取的是固定值"HBuilder"，需要提交App云端打包后运行才能获取真实的APPID值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + appid?: string; + /** + * 第三方程序调用时传递给程序的参数 + * 第三方程序传递过来的参数，字符串格式类型数据。 + * 不是由第三方程序调用启动，则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + arguments?: string; + /** + * 应用的渠道标识 + *

+ * 如果应用没有设置渠道标识，则返回空字符串。 + * 以下是流应用环境中使用的特殊渠道标识： + *

    + *
  • "qihoo:browser" - 表示360浏览器流应用
    • + *
  • "qihoo:appstore " - 表示360手机助手流应用
    • + *
  • "dcloud:streamapps" - 表示DCloud流应用基座
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + channel?: string; + /** + * 应用启动来源 + *

+ * 5+ APP启动类型，可取以下值： + *

    + *
  • "default"：默认启动方式，通常表示应用列表启动（360手助中搜索启动）
    • + *
  • "scheme"：通过urlscheme方式触发启动
    • + *
  • "push"：通过点击系统通知方式触发启动
    • + *
  • "stream"：通过流应用api（plus.stream.open）启动
    • + *
  • "shortcut"：通过快捷方式启动，iOS平台表示通过3D Touch快捷方式，Android平台表示通过桌面快捷方式启动
    • + *
  • "barcode"：通过二维码扫描启动
    • + *
  • "myapp"：通过流应用"我的"应用列表或历史列表中触发启动
    • + *
  • "favorite"：通过流应用的"收藏"应用列表启动
    • + *
  • "browser"：通过流应用的内置浏览器导流启动的流应用（地址栏输入url启动应用、点击wap页面链接启动应用）
    • + *
  • "engines"：通过流应用的浏览器界面作为搜索引擎启动
    • + *
  • "search"：通过流应用的应用搜索启动应用（如iOS平台的T9键盘搜索）
    • + *
  • "speech"：通过流应用的语音识别启动应用
    • + *
  • "uniLink"：通过通用链接（universal link）启动应用
    • + *
  • "miniProgram"：通过微信小程序启动应用
    • + *
+ *

+ * - default: + * 默认启动方式，通常表示从系统桌面图标启动 + * + * - scheme: + * 通过urlscheme方式触发启动 + * + * - push: + * 通过点击系统通知方式触发启动 + * + * - stream: + * 通过流应用api（plus.stream.open）启动 + * + * - shortcut: + * iOS平台表示通过3D Touch快捷方式，Android平台表示通过桌面快捷方式启动 + * + * - barcode: + * 通过二维码扫描启动 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + launcher?: 'default' | 'scheme' | 'push' | 'stream' | 'shortcut' | 'barcode'; + /** + * 应用安装来源 + *

+ * 5+应用安装来源，可取以下值： + *

    + *
  • "default"：默认安装来源，apk/ipa安装包内置安装
    • + *
  • "stream"：通过流应用api（plus.stream.open）安装，仅流应用环境下支持
    • + *
  • "push"：通过点击系统通知方式触发安装，仅流应用环境下支持
    • + *
  • "scheme"：通过urlscheme方式触发安装，仅流应用环境下支持
    • + *
  • "barcode"：通过二维码扫描触发安装，仅流应用环境下支持
    • + *
  • "silent"：通过后台静默方式安装，仅流应用环境下支持
    • + *
  • "speech"：通过语音识别方式触发安装，仅流应用环境下支持
    • + *
  • "favorite"：通过收藏界面启动触发安装，仅流应用环境下支持
    • + *
+ *

+ * - default: + * 默认安装来源，apk/ipa安装包内置安装 + * + * - stream: + * 通过流应用api（plus.stream.open）安装 + * + * - push: + * 通过点击系统通知方式触发安装 + * + * - scheme: + * 通过urlscheme方式触发安装 + * + * - barcode: + * 通过二维码扫描触发安装 + * + * - silent: + * 通过后台静默方式安装 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + origin?: 'default' | 'stream' | 'push' | 'scheme' | 'barcode' | 'silent'; + /** + * 客户端的版本名称 + * 字符串类型，在编译环境中设置的apk/ipa版本名称。 + * Android平台对应AndroidManifest.xml中的android:versionName属性值； + * iOS平台对应Info.plist中的CFBundleShortVersionString字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + version?: string; + /** + * 客户端的版本号 + * 字符串类型，仅包含数字。 + * Android平台对应AndroidManifest.xml中的android:versionCode属性值； + * iOS平台对应Info.plist中CFBundleVersion字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + versionCode?: string; + /** + * 客户端5+运行环境的内部版本号 + * 5+运行环境内部版本号，格式为：[主版本号].[次版本号].[修订版本号].[编译代号]。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + innerVersion?: string; + /** + * 客户端uni-app运行环境的版本号 + * uni-app运行环境版本号，格式为：[主版本号].[次版本号].[修订版本号]。 + * 注意：仅在uni-app应用中才能获取此版本号，非uni-app应用中返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + uniVersion?: string; + /** + * 获取当前应用首页加载的时间 + * 应用加载首页面的总时间，从开始加载首页面到首页面加载完成，单位为ms。 + * 注意，应用首页为网络地址则包括网络传输时间。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + launchLoadedTime?: number; + /** + * 获取当前应用的进程标识 + * 当前应用所属系统进程标识。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + processId?: string; + /** + * 获取当前应用的启动时间戳 + * 应用启动时间戳，距1970年1月1日之间的毫秒数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + startupTime?: number; + /** + * 应用是否由于内核崩溃自动恢复 + * 如果应用是由于内核（WKWebview）崩溃恢复则返回true，否则返回false。 + * 注意：仅iOS平台使用WKWebview内核时生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + isRecovery?: boolean; + /** + * 用户同意隐私政策 + *

+ * HBuilderX2.5.11+版本支持，配置为自定义隐私政策提示框时有效，参考： https://ask.dcloud.net.cn/article/36937 + * 设置应用状态为用户同意隐私政策，可通过plus.runtime.isAgreePrivacy判断是否已经同意。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + agreePrivacy(): void; + /** + * 用户不同意隐私政策 + *

+ * HBuilderX2.5.11+版本支持，配置为自定义隐私政策提示框时有效，参考： https://ask.dcloud.net.cn/article/36937 + * 设置应用状态为用户不同意隐私政策，可通过plus.runtime.isAgreePrivacy判断是否已经同意。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + disagreePrivacy(): void; + /** + * 查询用户是否同意隐私政策 + *

+ * HBuilderX2.5.11+版本支持，配置为自定义隐私政策提示框时有效，参考： https://ask.dcloud.net.cn/article/36937 + * 查询当前应用是否用户同意隐私政策。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + isAgreePrivacy(): boolean; + /** + * 获取指定APPID对应的应用信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + getProperty(appid: string, getPropertyCB: (result: PlusRuntimeWidgetInfo) => void): void; + /** + * 安装应用 + * 支持以下类型安装包： + * 1. 应用资源安装包（wgt），扩展名为'.wgt'； + * 2. 应用资源差量升级包（wgtu），扩展名为'.wgtu'； + * 3. 系统程序安装包（apk），要求使用当前平台支持的安装包格式。 + * 注意：仅支持本地地址，调用此方法前需把安装包从网络地址或其他位置放置到运行时环境可以访问的本地目录。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + install(filePath: string, options?: PlusRuntimeWidgetOptions, installSuccessCB?: (result: PlusRuntimeWidgetInfo) => void, installErrorCB?: (result: any) => void): void; + /** + * 退出应用 + * 5+APP：退出应用，返回系统桌面； + * 流应用：在“流应用”中调用则退出当前流应用，返回进入应用前的界面（如应用列表）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + quit(): void; + /** + * 重启当前的应用 + * 应用热重启，重新启动进入首页。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + restart(): void; + /** + * 设置应用图标上显示的角标数字 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + setBadgeNumber(number: number, options?: PlusRuntimeBadgeOptions): void; + /** + * 调用第三方程序打开指定的URL + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + openURL(url: string, errorCB?: (result: any) => void, identity?: string): void; + /** + * 使用内置Webview窗口打开URL + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + openWeb(url: string): void; + /** + * 调用第三方程序打开指定的文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + openFile(filepath: string, options?: PlusRuntimeOpenFileOptions, errorCB?: (result: any) => void): void; + /** + * 打开指定的文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + openDocument(filepath: string, options?: PlusRuntimeOpenFileOptions, successCB?: () => void, errorCB?: (result: any) => void): void; + /** + * 处理直达页面链接参数 + * 通过URL Scheme启动时，可以在?后面添加__direct_page参数自定义直达页面地址， + * 如“streamapp://m3w.cn/s/HelloH5?__direct_page=http%3a%2f%2fm.weibo.cn%2fu%2f3196963860”； + * 在流应用SDK集成时也可以通过direct_page参数（原生调用Intent）设置。 + * 注意：仅第一次调用此API时返回直达页面链接地址，再次调用将返回空字符串；如果应用重新被带直达页面链接参数的URL Scheme启动/激活时，可再次调用此方法获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + processDirectPage(): string; + /** + * 调用第三方程序 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + launchApplication(appInf: PlusRuntimeApplicationInf, errorCB: (result: any) => void): void; + /** + * 判断第三方程序是否已存在 + * 如果第三方程序已安装则返回true，未安装则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + isApplicationExist(appInf: PlusRuntimeApplicationInf): boolean; + /** + * 判断是否自定义应用启动页面加载地址 + * 通过URL Scheme启动时，可以在?后面添加__launch_path参数自定义应用启动首页加载的页面地址， + * 如“streamapp://m3w.cn/s/HelloH5?__launch_path=http%3a%2f%2fm.weibo.cn%2fu%2f3196963860”； + * 在流SDK集成时也可以通过launch_path参数（原生调用Intent）设置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + isCustomLaunchPath(): boolean; +} + +/** + * JSON对象，打开第三方程序参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ +interface PlusRuntimeApplicationInf { + /** + * 第三方程序包名 + * 仅Android平台支持，表示程序的包名，其它平台忽略此属性值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + pname?: string; + /** + * 程序的操作行为 + * Android平台上与系统的action值一致；iOS平台为要调用程序的URLScheme格式字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + action?: string; + /** + * 新任务模式标记 + * 可取值： + * true-使用新任务模式标记（FLAG_ACTIVITY_NEW_TASK）启动应用； + * false-不使用新任务模式标记（FLAG_ACTIVITY_NEW_TASK）启动应用。 + * 默认值为true。 + * 注意：由于5+应用配置的launchMode为singleTask，所以另一个5+应用通过plus.runtime.launchApplication启动时如果应用已经在后台运行则不会触发newintent事件，为了避免此问题需要将newTask参数值设置为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + newTask?: boolean; + /** + * 调用程序的参数 + * 仅Android平台支持，为JSON格式，用于传递给要调用程序的参数，如extra:{url:"http://www.html5plus.org"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + extra?: any; +} + +/** + * JSON对象，应用角标显示需要的通知栏消息的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ +interface PlusRuntimeBadgeOptions { + /** + * 消息的标题 + * 默认值为应用的名称。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + title?: string; + /** + * 消息的内容 + * 默认值为“您有x条未读消息"”，其中x未设置的角标数字值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + content?: string; +} + +/** + * JSON对象，打开文件参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ +interface PlusRuntimeOpenFileOptions { + /** + * 优先使用的程序包名 + * 如果指定包名的程序已经安装，则调用其打开文件，若程序不支持打开文件则触发错误回调。 + * 如果指定包名的程序未安装，则弹出系统支持打开此文件的列表，由用户选择程序打开。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + pname?: string; + /** + * 弹出系统选择程序界面指示区域 + * JSON对象，格式如{top:10;left:10;width:200;height:200;}，所有值为像素值，左上坐标相对于容器webview的位置。仅在iPad设备平台有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + popover?: any; +} + +/** + * JSON对象，应用信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ +interface PlusRuntimeWidgetInfo { + /** + * 应用的APPID + * 对应manifest.json中的id字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + appid?: string; + /** + * 应用的版本名称 + * 对应manifest.json中的version->name字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + version?: string; + /** + * 应用的版本号 + * 对应manifest.json中的version->code字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + versionCode?: string; + /** + * 应用的名称 + * 对应manifest.json中的name字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + name?: string; + /** + * 应用描述信息 + * 对应manifest.json中的description字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + description?: string; + /** + * 应用描述信息 + * 对应manifest.json中的developer->name字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + author?: string; + /** + * 开发者邮箱地址 + * 对应manifest.json中的developer->email字段值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + email?: string; + /** + * 应用许可特性列表 + * 对应manifest.json中的permissions字段下所有键名的列表。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + features?: string []; +} + +/** + * JSON对象，应用安装参数 + * 可通过对象设置安装的应用是否进行appid校验、版本号校验等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ +interface PlusRuntimeWidgetOptions { + /** + * 是否强制安装 + * true表示强制安装，不进行版本号的校验；false则需要版本号校验，如果将要安装应用的版本号不高于现有应用的版本号则终止安装，并返回安装失败。 + * 仅安装wgt和wgtu时生效，默认值 false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/runtime.html](http://www.html5plus.org/doc/zh_cn/runtime.html) + */ + force?: boolean; +} + +/** + * SQLite模块用于操作本地数据库文件，可实现数据库文件的创建，执行SQL语句等功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqlite { + /** + * 打开数据库 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + openDatabaseOptions?: PlusSqliteOpenDatabaseOptions; + /** + * 判断数据库是否打开 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + isOpenDatabaseOptions?: PlusSqliteIsOpenDatabaseOptions; + /** + * 关闭数据库 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + closeDatabaseOptions?: PlusSqliteCloseDatabaseOptions; + /** + * 执行事务 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + transactionOptions?: PlusSqliteTransactionOptions; + /** + * 执行增删改等操作的SQL语句 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + executeSqlOptions?: PlusSqliteExecuteSqlOptions; + /** + * 执行查询的SQL语句 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + selectSqlOptions?: PlusSqliteSelectSqlOptions; + /** + * 打开数据库 + * 如果数据库存在则打开，不存在则创建。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + openDatabase(options: PlusSqliteOpenDatabaseOptions): void; + /** + * 判断数据库是否打开 + * 数据库已经打开则返回true，数据库没有打开则返回false。 + * HBuilderX1.9.0及以上版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + isOpenDatabase(options: PlusSqliteIsOpenDatabaseOptions): boolean; + /** + * 关闭数据库 + * 完成数据库操作后，必须关闭数据库，否则可能会导致系统资源无法释放。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + closeDatabase(options: PlusSqliteCloseDatabaseOptions): void; + /** + * 执行事务 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + transaction(options: PlusSqliteTransactionOptions): void; + /** + * 执行增删改等操作的SQL语句 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + executeSql(options: PlusSqliteExecuteSqlOptions): void; + /** + * 执行查询的SQL语句 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + selectSql(options: PlusSqliteSelectSqlOptions): void; +} + +/** + * 打开数据库 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqliteOpenDatabaseOptions { + /** + * 数据库名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + name?: string; + /** + * 数据库路径 + *

+ * 必须为本地地址，支持以下类型路径： + * 5+ API路径(RelativeURL) - 以"_"开头的相对路径，如"_doc/a.db"（推荐使用"_doc/x.db"目录保存）； + * 相对路径 - 相对于当前页面的host位置，如"a.db"（不推荐使用，相对路径无法写入数据，只能读取数据）； + * 绝对路径 - 系统绝对路径，如Android平台"/sdcard/a.db"，此类路径通常通过其它5+ API获取的（不推荐使用，无法跨平台）； + * 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * 注意：写入数据需符合系统沙盒权限机制，应用资源目录（_www）目录通常不允许写操作，只能读取。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + path?: string; + /** + * 打开数据库成功回调函数 + * 回调函数无返回参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + success?: (result: any) => void; + /** + * 打开数据库失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + fail?: (result: any) => void; +} + +/** + * 判断数据库是否打开 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqliteIsOpenDatabaseOptions { + /** + * 数据库名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + name?: string; + /** + * 数据库路径 + *

+ * 必须为本地地址，支持以下类型路径： + * 5+ API路径(RelativeURL) - 以"_"开头的相对路径，如"_doc/a.db"（推荐使用"_doc/x.db"目录保存）； + * 相对路径 - 相对于当前页面的host位置，如"a.db"（不推荐使用，相对路径无法写入数据，只能读取数据）； + * 绝对路径 - 系统绝对路径，如Android平台"/sdcard/a.db"，此类路径通常通过其它5+ API获取的（不推荐使用，无法跨平台）； + * 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * 注意：写入数据需符合系统沙盒权限机制，应用资源目录（_www）目录通常不允许写操作，只能读取。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + path?: string; +} + +/** + * 关闭数据库 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqliteCloseDatabaseOptions { + /** + * 数据库名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + name?: string; + /** + * 关闭数据库成功回调函数 + * 回调函数无返回参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + success?: (result: any) => void; + /** + * 关闭数据库失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + fail?: (result: any) => void; +} + +/** + * 执行事务 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqliteTransactionOptions { + /** + * 数据库名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + name?: string; + /** + * 需要执行的事务操作 + * 可选值：begin（开始事务）、commit（提交）、rollback（回滚）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + operation?: string; + /** + * 执行事务成功回调函数 + * 回调函数无返回参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + success?: (result: any) => void; + /** + * 执行事务失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + fail?: (result: any) => void; +} + +/** + * 执行增删改等操作的SQL语句 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqliteExecuteSqlOptions { + /** + * 数据库名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + name?: string; + /** + * 需要执行的SQL语句 + * 参数为字符串时，表示执行单条SQL语句； + * 参数为字符串数组时（HBuilderX2.5.5+支持），表示执行多条SQL语句，按数组顺序执行，某条SQL语句执行错误则终止。 + * 注意：Android平台不支持SQL语句中使用“;”分割多条命令，要运行多条命令请使用字符串数组参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + sql?: string []; + /** + * 执行SQL语句成功回调函数 + * 回调函数无返回参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + success?: (result: any) => void; + /** + * 执行SQL语句失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + fail?: (result: any) => void; +} + +/** + * 执行查询的SQL语句 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ +interface PlusSqliteSelectSqlOptions { + /** + * 数据库名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + name?: string; + /** + * 需要查询的SQL语句 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + sql?: string; + /** + * 执行SQL语句成功回调函数 + * 回调函数返回参数为JSON对象数组，其中JSON对象为查询的结果。 + * 如果未查询到数据则返回参数为空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + success?: (result: any) => void; + /** + * 执行SQL语句失败回调函数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/sqlite.html](http://www.html5plus.org/doc/zh_cn/sqlite.html) + */ + fail?: (result: any) => void; +} + +/** + * Storage模块管理应用本地数据存储区，用于应用数据的保存和读取。应用本地数据与localStorage、sessionStorage的区别在于数据有效域不同，前者可在应用内跨域操作，数据存储期是持久化的，并且没有容量限制。通过plus.storage可获取应用本地数据管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ +interface PlusStorage { + /** + * 清除存储数据 + * 清除存储的所有键名及键值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + clear(): void; + /** + * 异步清除存储数据 + * 异步清除存储的所有键名及键值。 + * 注意：HBuilderX2.6.6+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + clearAsync(successCB?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 获取所有键名 + * 获取存储的所有键名，如果没有存储数据则返回空数组。 + * 注意：HBuilderX2.6.6+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + getAllKeys(): string []; + /** + * 异步获取所有键名 + * 异步获取存储的所有键名，如果没有存储数据则返回空数组。 + * 注意：HBuilderX2.6.6+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + getAllKeysAsync(successCB?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 获取存储数据的个数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + getLength(): number; + /** + * 获取存储的键值 + * 通过键名获取对应存储的键值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + getItem(key: string): string; + /** + * 异步获取存储的键值 + * 通过键名异步获取对应存储的键值，获取成功通过successCB回调返回键值，失败则通过errorCB返回错误。 + * 注意：HBuilderX2.6.6+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + getItemAsync(key: string, successCB?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 获取键值对中指定索引值的key值 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + key(index: number): string; + /** + * 存储键值 + * 如果设置的键在数据存储中已经存在，则更新存储的键值。 + * 存储的键和值没有容量限制，但过多的数据量会导致效率降低，建议单个键值数据不要超过10Kb。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + setItem(key: string, value: string): void; + /** + * 异步存储键值 + * 如果设置的键在数据存储中已经存在，则更新存储的键值。 + * 存储的键和值没有容量限制，但过多的数据量会导致效率降低， + * 异步存储不阻塞js运行，但也不应该传入过大数据，建议单个键值数据不要超过100Kb。 + * 注意：HBuilderX2.6.6+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + setItemAsync(key: string, value: string, successCB?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 删除键值 + * 通过键名删除对应存储的键名及键值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + removeItem(key: string): void; + /** + * 异步删除键值 + * 通过键名异步删除对应存储的键名及键值。 + * 注意：HBuilderX2.6.6+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/storage.html](http://www.html5plus.org/doc/zh_cn/storage.html) + */ + removeItemAsync(key: string, successCB?: (result: any) => void, errorCB?: (result: any) => void): void; +} + +/** + * Stream模块操作流应用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStream { + /** + * JSON对象，启动流应用参数 + * 指定要启动的流应用标识、名称、图标、参数等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + StreamOptions?: PlusStreamStreamOptions; + /** + * JSON对象，流应用恢复运行的参数 + * 设置流应用恢复运行时的参数、splash、首页等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + StreamRestoreOptions?: PlusStreamStreamRestoreOptions; + /** + * 流应用恢复运行时启动界面配置参数 + * 设置流应用恢复运行时启动界面，如是否自动关闭、延时关闭时间、超时时间等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + StreamRestoreSplashscreenOptions?: PlusStreamStreamRestoreSplashscreenOptions; + /** + * JSON对象，启动流应用的首页窗口属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + LaunchWebviewStyles?: PlusStreamLaunchWebviewStyles; + /** + * JSON对象，流应用信息 + * 流应用标识、图标、是否下载完成等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + StreamInfo?: PlusStreamStreamInfo; + /** + * JSON对象，免流量操作参数 + * 包含电话号码、验证码等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + FreetrafficOptions?: PlusStreamFreetrafficOptions; + /** + * 启动流应用 + * 打开指定的流应用，在流应用中通过plus.runtime.launcher获取的值为"stream"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + open(options: PlusStreamStreamOptions, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 流应用激活统计 + * 提交统计数据到流应用服务器，表明业务系统激活成功。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + activate(): void; + /** + * 已下载流应用列表 + * 获取当前设备上已安装的所有流应用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + list(options: any, successCallback?: any, errorCallback?: any): void; + /** + * 预加载流应用 + * 预加载指定的流应用资源，下载应用资源等，并不运行流应用。 + * 如果应用资源已经下载，则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + preload(appid: string): void; + /** + * 删除流应用 + * 删除已下载的流应用，清空应用相关运行期保存的资源（如缓存、配置文件等）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + remove(appid: string): void; + /** + * 设置流应用恢复运行的参数 + * 当流应用运行数目超过限制（通常最多运行2个流应用），会自动关闭之前切换到后台运行的应用。 + * 可通过此方法设置应用被自动关闭后再次被唤醒恢复运行时的参数，流应用恢复运行流程与第一次启动一致（差别是会使用StreamRestoreOptions中配置的参数）。 + * 如果没有调用setRestoreState方法，则恢复运行时使用启动时（调用plus.stream.open方法）传入的参数。 + * 注意：如果通过plus.stream.open方法启动应用，则忽略此方法设置的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + setRestoreState(options: PlusStreamStreamRestoreOptions): void; + /** + * 请求免流量验证码 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + freetrafficRequest(options?: PlusStreamFreetrafficOptions, successCallback?: () => void, errorCallback?: (result: any) => void): void; + /** + * 免流量绑定手机号 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + freetrafficBind(options?: PlusStreamFreetrafficOptions, successCallback?: () => void, errorCallback?: (result: any) => void): void; + /** + * 解除免流量绑定 + * 解除当前设备绑定的手机号，如果设备未绑定则不执行操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + freetrafficRelease(): void; + /** + * 获取免流量状态信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + freetrafficInfo(successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 免流量是否生效 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + freetrafficIsValid(): boolean; +} + +/** + * JSON对象，启动流应用参数 + * 指定要启动的流应用标识、名称、图标、参数等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStreamStreamOptions { + /** + * 流应用运行模式 + * 可取值："test"表示测试版模式运行，其它值则为正式版本模式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + appmode?: string; + /** + * 流应用标识 + * 流应用唯一字符串标识。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + appid?: string; + /** + * 启动流应用的直达页面链接地址 + * 可在应用中通过plus.runtime.processDirectPage()方法获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + direct_page?: string; + /** + * 流应用运行参数 + * 启动流应用的扩展参数，可在流应用中通过plus.runtime.arguments获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + extras?: any; + /** + * 流应用图标 + * 流应用显示的图标路径（仅支持本地路径），在启动提示界面中显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + icon?: string; + /** + * 流应用启动类型 + * 流应用的启动类型，可在流应用中通过plus.runtime.launcher获取，默认值为“stream”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + launcher?: string; + /** + * 应用启动界面样式 + * 可取值： + * "auto"：自动选择启动界面，如果splash图片已经下载则显示splash图片，否则使用默认加载流应用界面； + * "default"：使用默认加载流应用界面（如在360浏览器环境中在标题栏下显示加载进度条）。 + * 默认值为"auto"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + splash?: string; + /** + * 流应用首页窗口对象样式 + * 如果流应用已经运行，从后台激活到前台时忽略此属性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + styles?: PlusStreamLaunchWebviewStyles; + /** + * 流应用名称 + * 流应用显示的标题，在启动提示界面中显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + title?: string; + /** + * 启动流应用的快捷方式逻辑 + * 可取值： + * "auto" - 检查并引导用户打开快捷方式权限，自动创建桌面快捷方式，在不支持快捷方式滤重的系统上仅创建一次； + * "force" - 检查并引导用户打开快捷方式权限，自动创建桌面快捷方式，在不支持快捷方式滤重的系统上每次都尝试创建； + * "none" - 不检查快捷方式权限，不创建桌面快捷方式（与从桌面快捷方式启动的流程一致）； + * "query" - 弹出询问提示框（底部显示），用户点击确定后创建桌面快捷方式（检查并引导用户打开快捷方式权限）； + * "tipOnce" - 业务逻辑与"auto"类似，差别是只会引导用户打开快捷方式权限一次、toast提示一次。 + * 默认值为"force"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + shortcut?: string; + /** + * 退出流应用的快捷方式逻辑 + * 可取值： + * "query" - 应用退出时检查是否创建桌面快捷方式，如果查询到没有创建则弹出询问框，用户点击确定后创建桌面快捷方式（检查并引导用户打开快捷方式权限）； + * "queryOnce" - 仅应用第一次退出检查，检查逻辑同query； + * "none" - 应用退出时不检查是否创建桌面快捷方式。 + * 默认值为"none"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + shortcutQuit?: string; +} + +/** + * JSON对象，流应用恢复运行的参数 + * 设置流应用恢复运行时的参数、splash、首页等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStreamStreamRestoreOptions { + /** + * 流应用运行参数 + * 启动流应用的扩展参数，可在流应用中通过plus.runtime.arguments获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + extras?: any; + /** + * 应用启动界面样式 + * 可取值： + * "auto"：自动选择启动界面，如果流应用自动关闭时截图成功则使用截图，如果splash图片已经下载则显示splash图片，否则使用默认加载流应用界面； + * "default"：使用默认加载流应用界面（如在360浏览器环境中在标题栏下显示加载进度条）。 + * 默认值为"auto"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + splash?: string; + /** + * 流应用首页窗口对象样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + styles?: PlusStreamLaunchWebviewStyles; + /** + * 流应用恢复运行时启动界面配置参数 + * 用于流应用自动关闭后恢复运行时调整启动界面配置参数，如将自动关闭splash调整为手动关闭，以便恢复上次运行状态后再进入应用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + splashscreen?: PlusStreamStreamRestoreSplashscreenOptions; +} + +/** + * 流应用恢复运行时启动界面配置参数 + * 设置流应用恢复运行时启动界面，如是否自动关闭、延时关闭时间、超时时间等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStreamStreamRestoreSplashscreenOptions { + /** + * 是否自动关闭启动界面 + * true表示应用启动后自动关闭启动界面，false表示应用启动后不自动关闭启动界面，需要在应用调用plus.navigator.closeSplashscreen()方法关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + autoclose?: boolean; + /** + * 启动界面超时时间 + * 单位为毫秒（ms），当启动界面超过此时间仍然未关闭时（不管autoclose值设置true还是false），应用将自动关闭启动界面。 + * 默认值为6000（即6秒）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + timeout?: number; +} + +/** + * JSON对象，启动流应用的首页窗口属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStreamLaunchWebviewStyles { + /** + * 流应用首页是否阻塞网络图片的加载 + * true表示阻塞网络图片的加载，false表示不阻塞网络图片的加载。默认值为false。 + * 设置后可通过Webview窗口对象的setBlockNetworkImage(false)方法修改设置来继续加载网络图片。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + blockNetworkImage?: boolean; + /** + * 指定流应用首页地址 + * 可使用网络地址（http://或https://开头），也可使用本地地址（相对应用资源路径）。 + * 也可使用特定地址： + * about:blank - 使用空白首页，仅加载内置注入的脚本（如all.js、wap2app.js、config.js等）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + launch_path?: string; + /** + * 指定首页Webview的id + * 如果未指定id，则使用应用的appid作为首页Webview的id。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + id?: string; + /** + * 流应用首页是否显示 + * true表示显示，false表示不显示。默认值为true。 + * 注意：流应用首页隐藏后，需要调用首页的setVisible方法显示，如plus.webview.getLaunchWebview().setVisible(true)。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + visible?: boolean; +} + +/** + * JSON对象，流应用信息 + * 流应用标识、图标、是否下载完成等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStreamStreamInfo { + /** + * 流应用标识 + * 流应用唯一字符串标识。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + id?: string; + /** + * 流应用的图标 + * 流应用下载的图标路径（本地路径），如果未下载完成则返回空。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + icon?: string; + /** + * 流应用是否下载完成 + * true表示流应用下载完成，false表示流应用未下载完成。 + * 注意，流应用未下载完成以让可以正常启动运行，启动后会自动下载。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + complete?: boolean; +} + +/** + * JSON对象，免流量操作参数 + * 包含电话号码、验证码等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ +interface PlusStreamFreetrafficOptions { + /** + * 电话号码 + * 免流量请求验证码、绑定设备使用的电话号码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + phone?: string; + /** + * 验证码 + * 免流量绑定设备使用的验证码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/stream.html](http://www.html5plus.org/doc/zh_cn/stream.html) + */ + code?: string; +} + +/** + * Uploader模块管理网络上传任务，用于从本地上传各种文件到服务器，并支持跨域访问操作。通过plus.uploader可获取上传管理对象。Uploader上传使用HTTP的POST方式提交数据，数据格式符合Multipart/form-data规范，即rfc1867（Form-based File Upload in HTML）协议。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ +interface PlusUploader { + /** + * Upload对象管理一个上传任务 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + Upload?: PlusUploaderUpload; + /** + * 上传任务事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + UploadEvent?: PlusUploaderUploadEvent; + /** + * 上传任务的状态，Number类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + UploadState?: PlusUploaderUploadState; + /** + * JSON对象，创建上传任务的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + UploadOptions?: PlusUploaderUploadOptions; + /** + * JSON对象，添加上传文件的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + UploadFileOptions?: PlusUploaderUploadFileOptions; + /** + * 新建上传任务 + * 请求上传管理创建新的上传任务，创建成功则返回Upload对象，用于管理上传任务。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + createUpload(url: string, options?: PlusUploaderUploadOptions, completedCB?: (result0: PlusUploaderUpload, result1: number) => void): PlusUploaderUpload; + /** + * 清除上传任务 + * 清除指定状态的上传任务。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + clear(state?: '0' | '1' | '2' | '3' | '4' | '5' | '-1'): void; + /** + * 枚举上传任务 + * 枚举指定状态的上传任务列表，通过enumCB回调函数返回结果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + enumerate(enumCB: (result: PlusUploaderUpload []) => void, state?: '0' | '1' | '2' | '3' | '4' | '5' | '-1'): void; + /** + * 开始所有上传任务 + * 开始所有处于未开始调度或暂停状态的上传任务。 + * 若上传任务数超过可并发处理的总数，超出的任务处于调度状态（等待上传），当有任务完成时根据调度状态任务的优先级选择任务开始上传。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + startAll(): void; +} + +/** + * Upload对象管理一个上传任务 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ +interface PlusUploaderUpload { + /** + * 上传任务的标识 + * 在创建任务时系统自动分配，用于标识上传任务的唯一性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + id?: string; + /** + * 上传文件的服务器地址 + * 调用plus.uploader.createUpload()方法创建上传任务时设置的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + url?: string; + /** + * 任务的状态 + * 上传任务的状态，参考UploadState，在UploadCompleteCallback事件和UploadStateChangedCallback事件触发时更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + state?: number; + /** + * 上传任务的参数 + * 上传任务配置的参数，参考UploadOptions。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + options?: PlusUploaderUploadOptions; + /** + * 上传任务完成后服务器返回的数据 + * 表示当前上传任务的状态，可通过addEventListener()方法监听statechanged事件监听任务状态的变化。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + responseText?: string; + /** + * 已完成上传数据的大小） + * 整数类型，单位为字节（byte），上传任务开始传输数据时，每次触发statechanged事件或上传任务完成更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + uploadedSize?: number; + /** + * 上传数据的总大小 + * 整数类型，单位为字节（byte），上传任务开始传输数据时更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + totalSize?: number; + /** + * 添加上传文件 + * 向上传任务中添加文件，必须在任务开始上传前调用。 + * 以下情况会导致添加上传文件失败： + * 1. options参数中指定的key在任务中已经存在，则添加失败返回false； + * 2. path参数指定的文件路径不合法或文件不存在，则添加失败返回false； + * 3. 上传任务已经开始调度，调用此方法则添加失败返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + addFile(path: string, options: PlusUploaderUploadFileOptions): boolean; + /** + * 添加上传数据 + * 向上传任务中添加数据，必须在任务开始上传前调用。 + * 以下情况会导致添加上传文件失败： + * 1. key参数中指定的键名在任务中已经存在，则添加失败返回false； + * 2. 上传任务已经开始调度，调用此方法则添加失败返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + addData(key: string, value: string): boolean; + /** + * 开始上传任务 + * 开始调度上传任务，如果任务已经处于开始状态则无任何响应。 + * 在创建任务或任务上传失败后调用可重新开始上传。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + start(): void; + /** + * 暂停上传任务 + * 暂停上传任务，如果任务已经处于初始状态或暂停状态则无任何响应。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + pause(): void; + /** + * 恢复暂停的上传任务 + * 继续暂停的上传任务，如果任务处于非暂停状态则无任何响应。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + resume(): void; + /** + * 取消上传任务 + * 如果任务未完成，则终止上传，并从任务列表中删除。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + abort(): void; + /** + * 添加上传任务事件监听器 + * 上传任务添加事件监听器后，当监听的事件发生时触发listener回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + addEventListener(type: 'statechanged', listener: (result0: PlusUploaderUpload, result1: number) => void, capture?: boolean): void; + /** + * 获取上传请求HTTP响应头部信息 + * HTTP响应头部全部内容作为未解析的字符串返回，如果没有接收到这个HTTP响应头数据或者上传请求未完成则为空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + getAllResponseHeaders(): string; + /** + * 获取上传请求指定的HTTP响应头部的值 + * 其参数是要返回的HTTP响应头部的名称，可以使用任何大小写来制定这个头部名字，和响应头部的比较是不区分大小写的。 + * 如果没有接收到这个头部或者伤处请求未完成则为空字符串；如果接收到多个有指定名称的头部，这个头部的值被连接起来并返回，使用逗号和空格分隔开各个头部的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + getResponseHeader(headerName?: string): string; + /** + * 设置上传请求的HTTP头数据 + * Http的Header应该包含在通过后续start()调用而发起的请求中，此方法必需在调用start()之前设置才能生效。 + * 如果带有指定名称的头部已经被指定了，这个头部的新值就是：之前指定的值，加上逗号、以及这个调用指定的值（形成一个数组）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + setRequestHeader(headerName: string, headerValue: string): void; +} + +/** + * 上传任务事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ +interface PlusUploaderUploadEvent { + /** + * 上传任务状态变化事件 + * 当上传任务状态发生变化时触发此事件，事件原型参考UploadStateChangedCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + statechanged?: string; +} + +/** + * 上传任务的状态，Number类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ +type PlusUploaderUploadState = undefined | 0 | 1 | 2 | 3 | 4 | 5 | -1; + +/** + * JSON对象，创建上传任务的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ +interface PlusUploaderUploadOptions { + /** + * 【已废弃】支持断点续传时，上传任务每次上传的文件块大小 + * 数值类型，单位为Byte（字节），默认值为102400，若设置值小于等于0则表示不分块上传。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + blocksize?: number; + /** + * 分块上传的大小 + * 单位为Kb，设置值小于等于0则不分块上传，默认为不分块上传。 + * Android平台需设置分块上传才能准确触发statechanged返回上传进度，如果不设置分块上传则在开始后快速返回上传完成进度，而实际并没有上传完。 + * 注意：分块上传需要服务器支持，如果服务器不支持则会上传失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + chunkSize?: number; + /** + * 网络请求类型 + * 仅支持http协议的“POST”请求。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + method?: string; + /** + * 上传任务的优先级 + * 数值类型，数值越大优先级越高，默认优先级值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + priority?: number; + /** + * 上传任务重试次数 + * 数值类型，默认为重试3次。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + retry?: number; + /** + * 上传任务重试间隔时间 + * 数值类型，单位为s(秒)，默认值为30s。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + retryInterval?: number; + /** + * 上传任务超时时间 + * 数值类型，单位为s(秒)，默认值为120s。 + * 超时时间为服务器响应请求的时间（不是上传任务完成的总时间），如果设置为0则表示永远不超时。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + timeout?: number; +} + +/** + * JSON对象，添加上传文件的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ +interface PlusUploaderUploadFileOptions { + /** + * 文件键名 + * 上传文件在上传任务中的键名，默认值为为文件名称。 + * 上传任务中如果已经存在相同key的上传文件或数据将导致添加文件失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + key?: string; + /** + * 文件名称 + * 上传文件的名称，默认值为上传文件路径中的名称。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + name?: string; + /** + * 文件类型 + * 上传文件的类型（如图片文件为“image/jpeg”），默认值自动根据文件后缀名称生成。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/uploader.html](http://www.html5plus.org/doc/zh_cn/uploader.html) + */ + mime?: string; +} + +/** + * Video模块管理多媒体视频相关能力，可用创建视频播放控件，直播推流控件等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +interface PlusVideo { + /** + * 视频播放控件对象 + *

+ * VideoPlayer对象表示视频播放控件对象，在窗口中播放视频，可支持本地视频(mp4/flv)，网络视频地址（mp4/flv/m3u8）及流媒体（rtmp/hls/rtsp）。 + * 编码格式： + *

    + *
  • Android平台：h264、mpeg4、flv、hevc、vp6f、vp8/9
    • + *
  • iOS平台：h264、mpeg4、flv、hevc、vp6f
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + VideoPlayer?: typeof PlusVideoVideoPlayer; + /** + * 视频播放控件参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + VideoPlayerStyles?: PlusVideoVideoPlayerStyles; + /** + * 视频播放控件事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + VideoPlayerEvents?: PlusVideoVideoPlayerEvents; + /** + * 直播推流控件对象 + * LivePusher对象表示直播推流控件对象，在窗口中显示捕获视频，实时推送到流媒体（RTMP）服务器。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + LivePusher?: typeof PlusVideoLivePusher; + /** + * 直播推流控件配置选项 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + LivePusherStyles?: PlusVideoLivePusherStyles; + /** + * 直播推流控件事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + LivePusherEvents?: PlusVideoLivePusherEvents; + /** + * 创建VideoPlayer对象 + * 调用此方法创建后并不会显示，需要调用Webview窗口的append方法将其添加到Webview窗口后才能显示。 + * 注意：此时需要通过styles参数的top/left/width/height属性设置控件的位置及大小。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + createVideoPlayer(id: string, styles?: PlusVideoVideoPlayerStyles): PlusVideoVideoPlayer; + /** + * 创建LivePusher对象 + * 调用此方法创建后并不会显示，需要调用Webview窗口的append方法将其添加到Webview窗口后才能显示。 + * 注意：此时需要通过styles参数的top/left/width/height属性设置控件的位置及大小。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + createLivePusher(id: string, styles?: PlusVideoLivePusherStyles): PlusVideoLivePusher; + /** + * 查找已经创建的VideoPlayer对象 + * 查找指定id的VideoPlayer对象，如果不存在则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + getVideoPlayerById(id: string): PlusVideoVideoPlayer; + /** + * 查找已经创建的LivePusher对象 + * 查找指定id的LivePusher对象，如果不存在则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + getLivePusherById(id: string): PlusVideoLivePusher; +} + +/** + * 视频播放控件对象 + *

+ * VideoPlayer对象表示视频播放控件对象，在窗口中播放视频，可支持本地视频(mp4/flv)，网络视频地址（mp4/flv/m3u8）及流媒体（rtmp/hls/rtsp）。 + * 编码格式： + *

    + *
  • Android平台：h264、mpeg4、flv、hevc、vp6f、vp8/9
    • + *
  • iOS平台：h264、mpeg4、flv、hevc、vp6f
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +declare class PlusVideoVideoPlayer { + /** + * 监听视频播放控件事件 + * 向视频播放控件添加事件监听器，当指定的事件发生时，将触发listener函数的执行。 + * 可多次调用此方法向视频播放控件添加多个监听器，当监听的事件发生时，将按照添加的先后顺序执行。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + addEventListener(event: 'play' | 'pause' | 'ended' | 'timeupdate' | 'fullscreenchange' | 'fullscreenclick' | 'waiting' | 'error', listener: (result: any) => void, capture?: boolean): void; + /** + * 设置视频播放控件参数 + * 用于动态更新视频播放控件的配置参数。 + * 注意：有些选项无法动态更新，只能创建时进行设置，详情参考VideoPlayerStyles。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + setStyles(styles: PlusVideoVideoPlayerStyles): void; + /** + * 设置视频播放控件参数（将废弃，使用setStyles） + * 用于动态更新视频播放控件的配置选项。 + * 注意：有些选项无法动态更新，只能创建时进行设置，详情参考VideoPlayerStyles。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + setOptions(options: PlusVideoVideoPlayerStyles): void; + /** + * 播放视频 + * 如果视频已经处于播放状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + play(): void; + /** + * 暂停视频 + * 如果视频未处于播放状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + pause(): void; + /** + * 跳转到指定位置 + * 如果视频未处于播放状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + seek(position: number): void; + /** + * 切换到全屏 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + requestFullScreen(direction: number): void; + /** + * 退出全屏 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + exitFullScreen(): void; + /** + * 停止播放视频 + * 如果视频未处于播放或暂停状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + stop(): void; + /** + * 隐藏视频播放控件 + * 隐藏只是控件不可见，控件依然存在并且不改变播放状态。 + * 如果控件已经隐藏，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + hide(): void; + /** + * 显示视频播放控件 + * 将隐藏的控件显示出来（回复到隐藏前的状态）。 + * 如果控件已经显示，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + show(): void; + /** + * 关闭视频播放控件 + * 关闭操作将释放控件所有资源，不再可用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + close(): void; + /** + * 发送弹幕 + * 如果视频未处于播放状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + sendDanmu(danmu: any): void; + /** + * 设置倍速播放 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + playbackRate(rate: number): void; + /** + * 创建VideoPlayer对象 + * 创建VideoPlayer对象，并指定VideoPlayer对象的在界面中关联div或object标签的id号。 + */ + constructor(id: string, styles?: PlusVideoVideoPlayerStyles); +} + +/** + * 视频播放控件参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +interface PlusVideoVideoPlayerStyles { + /** + * 视频资源地址 + * 支持本地地址，也支持网络地址及直播流（RTMP）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + src?: string; + /** + * 自定义请求头 + *

+ * 播放http/https协议的视频资源时设置请求的header。 + * 注意：HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + header?: any; + /** + * 视频初始播放位置 + * 单位为秒（s）。 + * 注意：仅在视频开始播放前设置有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'initial-time'?: number; + /** + * 视频长度 + * 单位为秒（s）。 + * 注意：仅在视频开始播放前设置有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + duration?: number; + /** + * 是否显示默认播放控件 + * 默认值为true。 + * 包括播放/暂停按钮、播放进度、时间等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + controls?: boolean; + /** + * 弹幕列表 + * 弹幕JSON对象包括属性：text（String类型，弹幕文本类容），color（String类型，弹幕颜色，格式为#RRGGBB），time（Number类型，弹幕出现的时间，单位为秒）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'danmu-list'?: any []; + /** + * 是否显示弹幕按钮 + * 默认值为false。 + * 注意：仅在控件构造时设置有效，不能动态更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'danmu-btn'?: boolean; + /** + * 是否展示弹幕 + * 默认值为false。 + * 注意：仅在控件构造时设置有效，不能动态更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'enable-danmu'?: boolean; + /** + * 是否自动播放 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + autoplay?: boolean; + /** + * 是否循环播放 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + loop?: boolean; + /** + * 是否静音播放 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + muted?: boolean; + /** + * 设置全屏时视频的方向 + * 不指定则根据宽高比自动判断。 + * 有效值为： 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度）。 + * 默认值为-90。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + direction?: number; + /** + * 是否显示视频中间的播放按钮 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'show-center-play-btn'?: boolean; + /** + * 是否显示全屏按钮 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'show-fullscreen-btn'?: boolean; + /** + * 加载视频时是否显示loading + *

+ * 默认值为true。 + * HBuilderX2.8.12+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'show-loading'?: boolean; + /** + * 是否显示静音按钮 + *

+ * 默认值为false。 + * 注意： HBuilderX2.9.10+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'show-mute-btn'?: boolean; + /** + * 是否显示播放进度 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'show-progress'?: boolean; + /** + * 是否显示视频底部控制栏的播放按钮 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'show-play-btn'?: boolean; + /** + * 是否开启控制进度的手势 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'enable-progress-gesture'?: boolean; + /** + * 当视频大小与 video 容器大小不一致时，视频的表现形式 + * 有效值为：contain（包含），fill（填充），cover（覆盖）。 + * 默认值为contain。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + objectFit?: string; + /** + * 视频封面的图片网络资源地址 + * 如果 controls 属性值为 false 则设置 poster 无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + poster?: string; + /** + * VideoPlayer控件左上角的垂直偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度； + * 自动计算，如"auto",根据height值自动计算，相对于父Webview窗口垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + top?: string; + /** + * VideoPlayer控件左上角的水平偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度； + * 自动计算，如"auto"，根据width值自动计算，相对于父Webview窗口水平居中。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + left?: string; + /** + * VideoPlayer控件的宽度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + width?: string; + /** + * VideoPlayer控件的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + height?: string; + /** + * VideoPlayer控件在Webview窗口的布局模式 + * 可取值： + * "static" - 静态布局模式，如果页面存在滚动条则随窗口内容滚动； + * "absolute" - 绝对布局模式，如果页面存在滚动条不随窗口内容滚动； + * 默认值为"static"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + position?: string; + /** + * 解码方式 + *

+ * 可取值： + *

    + *
  • "hardware" - 硬解码，优点是可以利用设备硬件进行加速，提高视频清晰度，缺点是在部分设备可能存在兼容性问题
    • + *
  • "software" - 软解码，优点是兼容性较好，缺点是性能不足
    • + *
+ * 默认值为"software"，如果播放视频出现清晰度不好的情况可以调整为"hardware"。 + * HBuilderX3.1.0+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + codec?: string; + /** + * 是否对http/https 视频源开启本地缓存 + *

+ * true表示开启缓存，重复播放视频会优先使用本地缓存，false表示不缓存。默认值为false。 + * 缓存策略：开启了此开关的视频源,在视频播放时会在本地保存缓存文件，如果本地缓存池已超过100M，在进行缓存前会清空之前的缓存。 + * 注意：不适用于m3u8等流媒体协议。 + * HBuilderX3.1.0+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + httpCache?: boolean; + /** + * 视频播放策略 + *

+ * 可取值： + *

    + *
  • 0 - 普通模式，适合播放本地视频文件
    • + *
  • 1 - 高清视频优化模式，增加缓冲区大小，采用open sl解码音频，避免音视频脱轨的问题，可能会降低首屏展现速度、视频帧率，出现开屏音频延迟等。 适用于高码率视频的极端场景
    • + *
  • 3 - M3U8优化模式，增加缓冲区大小，提升视频加载速度和流畅度，可能会降低首屏展现速度。 适用于M3U8在线播放的场景
    • + *
+ * 默认值为0。 + * HBuilderX3.1.0+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + playStrategy?: number; +} + +/** + * 视频播放控件事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +interface PlusVideoVideoPlayerEvents { + /** + * 视频播放事件 + * 当视频开始/继续播放时触发。 + * 无事件回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + play?: string; + /** + * 视频暂停事件 + * 当视频暂停播放时触发。 + * 无事件回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + pause?: string; + /** + * 视频结束事件 + * 当视频播放到末尾时触发。 + * 无事件回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + ended?: string; + /** + * 视频播放进度更新事件 + * 当视频播放进度变化时触发，触发频率250ms一次。 + * 事件回调函数参数event.detail = {currentTime:"Number类型，当前播放时间（单位为秒）",duration:"Number类型，视频总长度（单位为秒）"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + timeupdate?: string; + /** + * 视频播放全屏播放状态变化事件 + * 当视频播放进入或退出全屏时触发。 + * 事件回调函数参数event.detail = {fullScreen:"Boolean类型，当前状态是否为全屏", direction:"String类型，vertical或horizontal"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + fullscreenchange?: string; + /** + * 视频播放全屏播放时点击事件 + * 当视频播放进入全屏后，点击屏幕时触发。 + * 事件回调函数参数event.detail = { + * screenX:"Number类型，点击点相对于屏幕左侧边缘的 X 轴坐标", + * screenY:"Number类型，点击点相对于屏幕顶部边缘的 Y 轴坐标", + * screenWidth:"Number类型，屏幕总宽度", + * screenHeight:"Number类型，屏幕总高度"}。 + * 注意：HBuilderX2.6.3+版本支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + fullscreenclick?: string; + /** + * 视频缓冲事件 + * 当视频播放出现缓冲时触发。 + * 无事件回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + waiting?: string; + /** + * 视频错误事件 + * 当视频播放出错时触发。 + * 无事件回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + error?: string; +} + +/** + * 直播推流控件对象 + * LivePusher对象表示直播推流控件对象，在窗口中显示捕获视频，实时推送到流媒体（RTMP）服务器。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +declare class PlusVideoLivePusher { + /** + * 监听直播推流控件事件 + * 向直播推流控件添加事件监听器，当指定的事件发生时，将触发listener函数的执行。 + * 可多次调用此方法向直播推流控件添加多个监听器，当监听的事件发生时，将按照添加的先后顺序执行。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + addEventListener(event: 'statechange' | 'netstatus' | 'error', listener: (result: any) => void, capture?: boolean): void; + /** + * 设置直播推流控件参数 + * 用于动态更新直播推流控件的配置参数。 + * 注意：有些选项无法动态更新，只能创建时进行设置，详情参考LivePusherStyles。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + setStyles(styles: PlusVideoLivePusherStyles): void; + /** + * 设置直播推流控件参数（将废弃，使用setStyles） + * 用于动态更新直播推流控件的配置选项。 + * 注意：有些选项无法动态更新，只能创建时进行设置，详情参考LivePusherStyles。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + setOptions(options: PlusVideoLivePusherStyles): void; + /** + * 预览摄像头采集数据 + * 调用摄像头采集图像数据，并在推流控件中预览（此时不会向服务器推流，需调用start方法才开始推流）。 + * 注意：为了确保预览窗口大小正确，应该在创建控件后延时一定的时间（如500ms）进行预览。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + preview(): void; + /** + * 开始推流 + * 如果已经处于推流状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + start(successCB: () => void, errorCB?: () => void): void; + /** + * 停止推流 + * 如果未处于推流状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + stop(options?: any): void; + /** + * 暂停推流 + * 如果未处于推流状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + pause(): void; + /** + * 恢复推流 + * 如果未处于暂停状态，则操作无效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + resume(): void; + /** + * 切换前后摄像头 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + switchCamera(): void; + /** + * 快照 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + snapshot(successCB: () => void, errorCB?: () => void): void; + /** + * 关闭直播推流控件 + * 关闭操作将释放控件所有资源，不再可用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + close(): void; + /** + * 创建LivePusher对象 + * 创建LivePusher对象，并指定LivePusher对象的在界面中关联div或object标签的id号。 + */ + constructor(id: string, styles?: PlusVideoLivePusherStyles); +} + +/** + * 直播推流控件配置选项 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +interface PlusVideoLivePusherStyles { + /** + * 推流地址 + * 支持RTMP协议。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + url?: string; + /** + * 推流视频模式 + * 可取值：SD（标清）, HD（高清）, FHD（超清）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + mode?: string; + /** + * 是否静音 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + muted?: boolean; + /** + * 开启摄像头 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'enable-camera'?: boolean; + /** + * 自动聚集 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'auto-focus'?: boolean; + /** + * 是否美颜 + * 可取值0、1，其中0表示不使用美颜，1表示不使用美颜。 + * 默认值为0(不使用美颜)。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + beauty?: number; + /** + * 是否美白 + * 可取值0、1、2、3、4、5，其中0表示不使用美白，其余值分别表示美白的程度，值越大美白程度越大。 + * 默认值为0（不使用美白）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + whiteness?: number; + /** + * 宽高比 + * 可取值：3:4, 9:16。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + aspect?: string; + /** + * 最小码率 + * 默认值为200。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'min-bitrate'?: number; + /** + * 最大码率 + * 默认值为1000。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + 'max-bitrate'?: number; + /** + * LivePusher控件左上角的垂直偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度； + * 自动计算，如"auto",根据height值自动计算，相对于父Webview窗口垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + top?: string; + /** + * LivePusher控件左上角的水平偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度； + * 自动计算，如"auto"，根据width值自动计算，相对于父Webview窗口水平居中。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + left?: string; + /** + * LivePusher控件的宽度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + width?: string; + /** + * LivePusher控件的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + height?: string; + /** + * LivePusher控件在Webview窗口的布局模式 + * 可取值： + * "static" - 静态布局模式，如果页面存在滚动条则随窗口内容滚动； + * "absolute" - 绝对布局模式，如果页面存在滚动条不随窗口内容滚动； + * 默认值为"static"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + position?: string; +} + +/** + * 直播推流控件事件类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ +interface PlusVideoLivePusherEvents { + /** + * 状态变化事件 + * 当推流连接服务器状态变化时触发。 + * 事件回调函数参数event={type:"事件类型，此时为statechange",target:"触发此事件的直播推流控件对象",detail:{code:"状态码，参考后面状态码说明",message:"描述信息"}}。 + * 其中code状态码： + * 1001 - 已经连接推流服务器； + * 1002 - 已经与服务器握手完毕,开始推流； + * 1003 - 打开摄像头成功； + * 1004 - 录屏启动成功； + * 1005 - 推流动态调整分辨率； + * 1006 - 推流动态调整码率； + * 1007 - 首帧画面采集完成； + * 1008 - 编码器启动； + * -1301 - 打开摄像头失败； + * -1302 - 打开麦克风失败； + * -1303 - 视频编码失败； + * -1304 - 音频编码失败； + * -1305 - 不支持的视频分辨率； + * -1306 - 不支持的音频采样率； + * -1307 - 网络断连，且经多次重连抢救无效，更多重试请自行重启推流； + * -1308 - 开始录屏失败，可能是被用户拒绝； + * -1309 - 录屏失败，不支持的Android系统版本，需要5.0以上的系统； + * -1310 - 录屏被其他应用打断了； + * -1311 - Android Mic打开成功，但是录不到音频数据； + * -1312 - 录屏动态切横竖屏失败； + * 1101 - 网络状况不佳：上行带宽太小，上传数据受阻； + * 1102 - 网络断连, 已启动自动重连； + * 1103 - 硬编码启动失败,采用软编码； + * 1104 - 视频编码失败； + * 1105 - 新美颜软编码启动失败，采用老的软编码； + * 1106 - 新美颜软编码启动失败，采用老的软编码； + * 3001 - RTMP -DNS解析失败； + * 3002 - RTMP服务器连接失败； + * 3003 - RTMP服务器握手失败； + * 3004 - RTMP服务器主动断开，请检查推流地址的合法性或防盗链有效期； + * 3005 - RTMP 读/写失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + statechange?: string; + /** + * 网络状态通知事件 + * 当推流的网络状态发生变化时触发。 + * 事件回调函数参数event={type:"事件类型，此时为netstatus",target:"触发此事件的直播推流控件对象",detail:{videoBitrate:"视频码率",audioBitrate:"音频码率",videoFPS:"视频帧率",netSpeed:"推流网速",videoWidth:"视频宽度",videoHeight:"视频高度"}}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + netstatus?: string; + /** + * 渲染错误事件 + * 当推流发生错误是触发。 + * 事件回调函数参数event={type:"事件类型，此时为error",target:"触发此事件的直播推流控件对象",detail:{code:"错误编码，参考后面错误码说明",message:"描述信息"}}。 + * 其中code错误码： + * 1001 - 用户禁止使用摄像头； + * 1002 - 用户禁止使用录音。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/video.html](http://www.html5plus.org/doc/zh_cn/video.html) + */ + error?: string; +} + +/** + * Webview模块管理应用窗口界面，实现多窗口的逻辑控制管理操作。通过plus.webview可获取应用界面管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebview { + /** + * 一组用于定义页面或控件显示动画效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + AnimationTypeShow?: PlusWebviewAnimationTypeShow; + /** + * 一组用于定义页面或控件关闭的动画效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + AnimationTypeClose?: PlusWebviewAnimationTypeClose; + /** + * Webview窗口对象，用于操作加载HTML页面的窗口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewObject?: PlusWebviewWebviewObject; + /** + * Webview窗口动画参数 + * 用于指定动画目标窗口，起始位置、目标位置等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewAnimationOptions?: PlusWebviewWebviewAnimationOptions; + /** + * Webview窗口动画样式 + * 用于指定动画窗口的起始位置、目标位置等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewAnimationStyles?: PlusWebviewWebviewAnimationStyles; + /** + * Webview窗口回弹样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewBounceStyle?: PlusWebviewWebviewBounceStyle; + /** + * Webview窗口内容动画参数 + * 指定动画的类型、持续时间等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewContentAnimationOptions?: PlusWebviewWebviewContentAnimationOptions; + /** + * 原生控件在窗口中停靠的方式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewDock?: PlusWebviewWebviewDock; + /** + * Webview窗口滑动事件数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewDragEvent?: PlusWebviewWebviewDragEvent; + /** + * 窗口手势操作参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewDragOptions?: PlusWebviewWebviewDragOptions; + /** + * 手势操作关联对象参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewDragOtherViewOptions?: PlusWebviewWebviewDragOtherViewOptions; + /** + * 截屏绘制操作参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewDrawOptions?: PlusWebviewWebviewDrawOptions; + /** + * 窗口收藏参数 + * 在流应用环境中调用收藏功能时使用的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewFavoriteOptions?: PlusWebviewWebviewFavoriteOptions; + /** + * 创建加载HTML数据参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewLoadDataOptions?: PlusWebviewWebviewLoadDataOptions; + /** + * 窗口的分享参数 + * 在流应用环境中调用分享功能时使用的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewShareOptions?: PlusWebviewWebviewShareOptions; + /** + * 窗口原生子View控件样式 + * 可设置原生控件的标识、大小、位置以及绘制的内容等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewSubNViewStyles?: PlusWebviewWebviewSubNViewStyles; + /** + * 窗口标题栏控件样式 + *

+ * 标题栏控件固定高度为44px,可通过Webview窗口对象的getTitleNView方法获取标题栏原生控件对象plus.nativeObj.View，调用其方法绘制自定义内容。 + * 可以通过WebviewObject对象的setStyle方法传入titleNView属性更新样式，如wobj.setStyle({titleNView:{titleColor:'#FF0000'}})。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewTitleNViewStyles?: PlusWebviewWebviewTitleNViewStyles; + /** + * 窗口标题栏自定义返回按钮样式 + *

+ * 返回按钮由返回图标（字体图标）和标题组成。 + * 默认只显示返回图标。 + * 注意：HBuilderX2.6.3+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewTitleNViewBackButtonStyles?: PlusWebviewWebviewTitleNViewBackButtonStyles; + /** + * 窗口标题栏自定义按钮样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewTitleNViewButtonStyles?: PlusWebviewWebviewTitleNViewButtonStyles; + /** + * 窗口标题栏搜索框样式 + * 搜索输入框输入内容变化时触发"titleNViewSearchInputChanged"事件； + * 用户点击软键盘上的“搜索”按钮时触发"titleNViewSearchInputConfirmed"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewTitleNViewSearchInputStyles?: PlusWebviewWebviewTitleNViewSearchInputStyles; + /** + * 标题栏控件的进度条样式 + * 显示在标题栏控件底部。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewProgressStyles?: PlusWebviewWebviewProgressStyles; + /** + * 窗口标题栏控件的分割线样式 + * 显示在标题栏控件底部。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewSplitLineStyles?: PlusWebviewWebviewSplitLineStyles; + /** + * Webview窗口事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewEvent?: PlusWebviewWebviewEvent; + /** + * JSON对象，原生窗口扩展参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewExtraOptions?: PlusWebviewWebviewExtraOptions; + /** + * 原生控件在窗口中显示的位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewPosition?: PlusWebviewWebviewPosition; + /** + * Webview窗口下拉刷新样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewPullToRefreshStyles?: PlusWebviewWebviewPullToRefreshStyles; + /** + * Webview窗口rendered事件参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewRenderedEventOptions?: PlusWebviewWebviewRenderedEventOptions; + /** + * 替换H5标准API配置信息 + * 目前仅支持替换H5标准定位接口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewReplaceWebApiOptions?: PlusWebviewWebviewReplaceWebApiOptions; + /** + * JSON对象，Webview窗口的系统状态栏区域样式 + * 仅在应用设置为沉浸式状态栏样式下有效，非沉浸式状态栏样式下忽略此属性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewStatusbarStyles?: PlusWebviewWebviewStatusbarStyles; + /** + * JSON对象，Webview窗口对象的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewStyles?: PlusWebviewWebviewStyles; + /** + * 一组用于定义页面或控件变形的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewTransform?: PlusWebviewWebviewTransform; + /** + * 一组用于定义页面或控件转换效果的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewTransition?: PlusWebviewWebviewTransition; + /** + * 拦截Webview窗口资源请求的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewOverrideResourceOptions?: PlusWebviewWebviewOverrideResourceOptions; + /** + * 拦截Webview窗口URL请求的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewOverrideUrlOptions?: PlusWebviewWebviewOverrideUrlOptions; + /** + * 监听Webview窗口资源加载的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + WebviewListenResourceOptions?: PlusWebviewWebviewListenResourceOptions; + /** + * 当前Webview窗口是否由于内核崩溃自动恢复 + * 如果当前窗口是由于内核（WKWebview）崩溃恢复则返回true，否则返回false。 + * 注意：仅iOS平台使用WKWebview内核时生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + isRecovery?: boolean; + /** + * 获取所有Webview窗口 + * 获取应用中已创建的所有Webview窗口，包括所有未显示的Webview窗口。 + * 返回WebviewObject对象在数组中按创建的先后顺序排列，即数组中第一个WebviewObject对象用是加载应用的入口页面。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + all(): PlusWebviewWebviewObject []; + /** + * 关闭Webview窗口 + * 关闭已经打开的Webview窗口，需先获取窗口对象或窗口id，并可指定关闭窗口的动画及动画持续时间。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + close(id_wvobj: string | PlusWebviewWebviewObject, aniClose?: 'auto' | 'none' | 'slide-out-right' | 'slide-out-left' | 'slide-out-top' | 'slide-out-bottom' | 'fade-out' | 'zoom-in' | 'zoom-fade-in' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-backward' | 'pop-out', duration?: number, extras?: PlusWebviewWebviewExtraOptions): void; + /** + * 创建新的Webview窗口 + * 创建Webview窗口，用于加载新的HTML页面，可通过styles设置Webview窗口的样式，创建完成后需要调用show方法才能将Webview窗口显示出来。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + create(url?: string, id?: string, styles?: PlusWebviewWebviewStyles, extras?: any): PlusWebviewWebviewObject; + /** + * 获取当前窗口的WebviewObject对象 + * 获取当前页面所属的Webview窗口对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + currentWebview(): PlusWebviewWebviewObject; + /** + * 获取屏幕所有可视的Webview窗口 + * 仅在屏幕区域显示的Webview窗口，如果Webview窗口显示了但被其它Webview窗口盖住则认为不可视。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getDisplayWebview(): PlusWebviewWebviewObject []; + /** + * 查找指定标识的WebviewObject窗口 + * 在已创建的窗口列表中查找指定标识的Webview窗口并返回。 + * 若没有查找到指定标识的窗口则返回null，若存在多个相同标识的Webview窗口，则返回第一个创建的Webview窗口。 + * 如果要获取应用入口页面所属的Webview窗口，其标识为应用的%APPID%，可通过plus.runtime.appid获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getWebviewById(id: string): PlusWebviewWebviewObject; + /** + * 获取应用首页WebviewObject窗口对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getLaunchWebview(): PlusWebviewWebviewObject; + /** + * 获取应用第二个首页WebviewObject窗口对象 + * 在双首页模式下（在manifest.json的plus->secondwebview节点下配置），应用会自动创建两个首页Webview，通过getLaunchWebview()可获取第一个首页窗口对象，通过getSecondWebview()可获取第二个首页窗口对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getSecondWebview(): PlusWebviewWebviewObject; + /** + * 获取应用显示栈顶的WebviewObject窗口对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getTopWebview(): PlusWebviewWebviewObject; + /** + * 隐藏Webview窗口 + * 根据指定的WebviewObject对象或id隐藏Webview窗口，使得窗口不可见。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + hide(id_wvobj: string | PlusWebviewWebviewObject, aniHide?: 'auto' | 'none' | 'slide-out-right' | 'slide-out-left' | 'slide-out-top' | 'slide-out-bottom' | 'fade-out' | 'zoom-in' | 'zoom-fade-in' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-backward' | 'pop-out', duration?: number, extras?: PlusWebviewWebviewExtraOptions): void; + /** + * 创建并打开Webview窗口 + * 创建并显示Webview窗口，用于加载新的HTML页面，可通过styles设置Webview窗口的样式，创建完成后自动将Webview窗口显示出来。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + open(url?: string, id?: string, styles?: PlusWebviewWebviewStyles, aniShow?: 'auto' | 'none' | 'slide-in-right' | 'slide-in-left' | 'slide-in-top' | 'slide-in-bottom' | 'fade-in' | 'zoom-out' | 'zoom-fade-out' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-forward' | 'pop-in', duration?: number, showedCB?: () => void): PlusWebviewWebviewObject; + /** + * 预载网络页面 + * 预载网络页面会向服务器发起http/https请求获取html页面内容， + * 待Webview窗口加载此url页面时会则根据缓存机制优先使用预载的页面内容(加快页面显示速度)。 + * 注意：预载网络页面仅在运行期生效，为了节省内存仅保留最后5个预载页面数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + prefetchURL(url: string): void; + /** + * 预载网络页面（多个地址） + * 预载网络页面会向服务器发起http/https请求获取html页面内容， + * 待Webview窗口加载此url页面时会则根据缓存机制优先使用预载的页面内容(加快页面显示速度)。 + * 注意：预载网络页面仅在运行期生效，为了节省内存仅保留最后5个预载页面数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + prefetchURLs(urls: string []): void; + /** + * 显示Webview窗口 + * 显示已创建或隐藏的Webview窗口，需先获取窗口对象或窗口id，并可指定显示窗口的动画及动画持续时间。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + show(id_wvobj: string | PlusWebviewWebviewObject, aniShow?: 'auto' | 'none' | 'slide-in-right' | 'slide-in-left' | 'slide-in-top' | 'slide-in-bottom' | 'fade-in' | 'zoom-out' | 'zoom-fade-out' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-forward' | 'pop-in', duration?: number, showedCB?: () => void, extras?: PlusWebviewWebviewExtraOptions): PlusWebviewWebviewObject; + /** + * Webview窗口组合动画 + * 同步组合两个Webview窗口动画，动画完成后窗口的位置会发生变化，一次需要在动画属性参数中设置动画起始位置、结束位置等。 + * 注意：此动画操作会改变窗口位置（如left值等），再次调用show方法时需要确保其位置是否在可视区域，如果不在可视区域则需要调用窗口的setStyle方法设置其位置到可视区域内，如setStyle({left:'0px'});。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + startAnimation(options: PlusWebviewWebviewAnimationOptions, otherOptions?: PlusWebviewWebviewAnimationOptions, callback?: (result: any) => void): void; + /** + * 获取Webview默认是否开启硬件加速 + * 由于不同设备对硬件加速的支持情况存在差异，开启硬件加速能加速HTML页面的渲染，但也会消耗更多的系统资源，从而导致在部分设备上可能出现闪屏、发虚、分块渲染等问题， 因此5+ Runtime会根据设备实际支持情况自动选择是否开启硬件加速。 + * 关闭硬件加速则可能会导致Webview页面无法支持Video标签播放视频等问题，如果在特定情况下需要调整修改默认开启硬件加速的行为，则可通过plus.webview.defaultHardwareAccelerated()方法获取当前设备默认是否开启硬件加速状态，从而决定是否需要显式开启或关闭指定Webview的硬件加速功能（通过WebviewStyles的hardwareAccelerated属性设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + defaultHardwareAccelerated(): boolean; +} + +/** + * 一组用于定义页面或控件显示动画效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewAnimationTypeShow { + /** + * 自动选择动画效果 + * 自动选择动画效果，使用上次显示窗口设置的动画效果，如果是第一次显示则默认动画效果“none”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + auto?: string; + /** + * 无动画效果 + * 立即显示页面，无任何动画效果，页面显示默认的动画效果。 + * 此效果忽略动画时间参数，立即显示。 + * 对应关闭动画"none"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + none?: string; + /** + * 从右侧横向滑动效果 + * 页面从屏幕右侧外向内横向滑动显示。 + * 对应关闭动画"slide-out-right"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-in-right'?: string; + /** + * 从左侧横向滑动效果 + * 页面从屏幕左侧向右横向滑动显示。 + * 对应关闭动画"slide-out-left"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-in-left'?: string; + /** + * 从上侧竖向滑动效果 + * 页面从屏幕上侧向下竖向滑动显示。 + * 对应关闭动画"slide-out-top"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-in-top'?: string; + /** + * 从下侧竖向滑动效果 + * 页面从屏幕下侧向上竖向滑动显示。 + * 对应关闭动画"slide-out-bottom"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-in-bottom'?: string; + /** + * 从透明到不透明逐渐显示效果 + * 页面从完全透明到不透明逐渐显示。 + * 对应关闭动画"fade-out"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'fade-in'?: string; + /** + * 从小到大逐渐放大显示效果 + * 页面在屏幕中间从小到大逐渐放大显示。 + * 对应关闭动画"zoom-in"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'zoom-out'?: string; + /** + * 从小到大逐渐放大并且从透明到不透明逐渐显示效果 + * 页面在屏幕中间从小到大逐渐放大并且从透明到不透明逐渐显示。 + * 对应关闭动画"zoom-fade-in"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'zoom-fade-out'?: string; + /** + * 从右侧平移入栈动画效果 + * 页面从屏幕右侧滑入显示，同时上一个页面带阴影效果从屏幕左侧滑出隐藏。 + * 对应关闭动画"pop-out"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'pop-in'?: string; +} + +/** + * 一组用于定义页面或控件关闭的动画效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewAnimationTypeClose { + /** + * 自动选择动画效果 + * 自动选择显示窗口相对于的动画效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + auto?: string; + /** + * 无动画 + * 立即关闭页面，无任何动画效果。 + * 此效果忽略动画时间参数，立即关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + none?: string; + /** + * 横向向右侧滑出屏幕动画 + * 页面从屏幕中横向向右侧滑动到屏幕外关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-out-right'?: string; + /** + * 横向向左侧滑出屏幕动画 + * 页面从屏幕中横向向左侧滑动到屏幕外关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-out-left'?: string; + /** + * 竖向向上侧滑出屏幕动画 + * 页面从屏幕中竖向向上侧滑动到屏幕外关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-out-top'?: string; + /** + * 竖向向下侧滑出屏幕动画 + * 页面从屏幕中竖向向下侧滑动到屏幕外关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'slide-out-bottom'?: string; + /** + * 从不透明到透明逐渐隐藏动画 + * 页面从不透明到透明逐渐隐藏关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'fade-out'?: string; + /** + * 从大逐渐缩小关闭动画 + * 页面逐渐向页面中心缩小关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'zoom-in'?: string; + /** + * 从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画 + * 页面逐渐向页面中心缩小并且从不透明到透明逐渐隐藏关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'zoom-fade-in'?: string; + /** + * 从右侧平移出栈动画效果 + * 页面从屏幕右侧滑出消失，同时上一个页面带阴影效果从屏幕左侧滑入显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'pop-out'?: string; +} + +/** + * Webview窗口对象，用于操作加载HTML页面的窗口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewObject { + /** + * Webview窗口的标识 + *

+ * 调用plus.webview.create或plus.webview.open新建窗口时传入的id参数值，如果没有设置id参数，此属性值为undefined。 + * 注意：窗口标识只能在创建时设置，不支持动态修改，不要对此属性进行赋值操作。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + id: string; + /** + * Webview窗口关闭事件 + * 当Webview窗口关闭时触发此事件，类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + onclose: (result: any) => void; + /** + * Webview窗口错误事件 + * 当Webview窗口加载错误时触发此事件，类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + onerror: (result: any) => void; + /** + * Webview窗口页面加载完成事件 + * 当Webview窗口页面加载完成时触发此事件，类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + onloaded: (result: any) => void; + /** + * Webview窗口页面开始加载事件 + * 当Webview窗口开始加载新页面时触发此事件，类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + onloading: (result: any) => void; + /** + * 添加事件监听器 + * 向Webview窗口添加事件监听器，当指定的事件发生时，将触发listener函数的执行。 + * 可多次调用此方法向Webview添加多个监听器，当监听的事件发生时，将按照添加的先后顺序执行。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + addEventListener(event: 'close' | 'dragBounce' | 'error' | 'hide' | 'loading' | 'loaded' | 'maskClick' | 'show' | 'popGesture' | 'titleUpdate', listener: (result: any) => void, capture?: boolean): void; + /** + * 在Webview窗口中添加子窗口 + * 将另一个Webview窗口作为子窗口添加到当前Webview窗口中，添加后其所有权归父Webview窗口，当父窗口关闭时子窗口自动关闭。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + append(webview: PlusNativeObjView | PlusWebviewWebviewObject): void; + /** + * 添加Webview窗口预加载js文件 + * 对于一些网络HTML页面，在无法修改HTML页面时可通过此方法自动加载本地js文件。 + * 当Webview窗口跳转到新页面时也会自动加载指定的js执行，添加多个js文件将按照添加的先后顺序执行。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + appendJsFile(file: string): void; + /** + * Webview窗口内容动画 + * 动画后可能会导致Webview窗口显示内容改变，可通过调用restore方法恢复。 + * 当Webview窗口内容动画引起内容不可见（透明），将显示此窗口后面的内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + animate(options?: PlusWebviewWebviewContentAnimationOptions, callback?: () => void): void; + /** + * 后退到上次加载的页面 + * Webview窗口历史记录操作，后退到窗口上次加载的HTML页面。 + * 如果窗口历史记录中没有可后退的页面则不触发任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + back(): void; + /** + * 开始Webview窗口的下拉刷新 + * 开始触发下拉刷新效果，与用户操作下拉刷新行为一致（有动画效果）。 + * 触发setPullTorefresh方法设置的下拉刷新事件回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + beginPullToRefresh(): void; + /** + * 查询Webview窗口是否可后退 + * Webview窗口历史记录查询操作，获取Webview是否可后退到历史加载的页面，结果通过queryCallback回调方法返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + canBack(queryCallback: (result: any) => void): void; + /** + * 查询Webview窗口是否可前进 + * Webview窗口历史记录查询操作，获取Webview是否可前进到历史加载的页面，结果通过queryCallback回调方法返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + canForward(queryCallback: (result: any) => void): void; + /** + * 检测Webview窗口是否渲染完成 + * 检测方式为判断的Webview窗口内容是否为白屏，如果非白屏则认为渲染完成，否则认为渲染未完成。 + * 通过successCallback回调函数返回结果，如果检测过程中发生错误则触发errorCallback回调函数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + checkRenderedContent(options?: PlusWebviewWebviewRenderedEventOptions, successCallback?: () => void, errorCallback?: (result: any) => void): void; + /** + * 获取Webview窗口的所有子Webview窗口 + * 获取添加到Webview窗口中的所有子Webview窗口，如果没有子Webview窗口则返回空数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + children(): PlusWebviewWebviewObject []; + /** + * 清空原生Webview窗口加载的内容 + * 清除原生窗口的内容，用于重置原生窗口加载的内容，清除其加载的历史记录等内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + clear(): void; + /** + * 关闭Webview窗口 + * 关闭并销毁Webview窗口，可设置关闭动画和动画持续时间。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + close(aniClose?: 'auto' | 'none' | 'slide-out-right' | 'slide-out-left' | 'slide-out-top' | 'slide-out-bottom' | 'fade-out' | 'zoom-in' | 'zoom-fade-in' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-backward' | 'pop-out', duration?: number, extras?: PlusWebviewWebviewExtraOptions): void; + /** + * 设置Webview窗口的滑屏操作手势 + * 将Webview窗口的左右滑动手势关联到其它Webview窗口，可实现滑动切换显示Webview的动画效果（如Tab页面切换效果）。 + * 注意：滑屏操作会改变窗口位置（如left值等），如果不在可视区域则需要调用窗口的setStyle方法设置其位置到可视区域内，如setStyle({left:'0px'});。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + drag(options: PlusWebviewWebviewDragOptions, otherView?: PlusWebviewWebviewDragOtherViewOptions, callback?: (result: PlusWebviewWebviewDragEvent) => void): void; + /** + * 截屏绘制 + * 将Webview窗口的可视区域截屏并绘制到Bitmap图片对象中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + draw(bitmap?: PlusNativeObjBitmap, successCallback?: () => void, errorCallback?: (result: any) => void, options?: PlusWebviewWebviewDrawOptions): void; + /** + * 结束Webview窗口的下拉刷新 + * 关闭下拉刷新效果，恢复到开始下拉刷新之前的效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + endPullToRefresh(): void; + /** + * 在Webview窗口中执行JS脚本 + * 将JS脚本发送到Webview窗口中运行，可用于实现Webview窗口间的数据通讯。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + evalJS(js: string): void; + /** + * 前进到上次加载的页面 + * Webview窗口历史记录操作，前进到窗口上次加载的HTML页面。 + * 如果窗口历史记录中没有可前进的页面则不触发任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + forward(): void; + /** + * 获取Webview窗口的收藏参数 + * 获取Webview窗口的收藏参数，如收藏页面的标题、图标、地址等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getFavoriteOptions(): PlusWebviewWebviewFavoriteOptions; + /** + * 获取页面的安全区域 + * Webview窗口内容区域的安全区域位置信息。 + * 如页面底部与底部安全区域重叠10px， 则返回的bottom值为10，否则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getSafeAreaInsets(): PlusNavigatorSafeAreaInsets; + /** + * 获取Webview窗口的分享参数 + * 获取Webview窗口的分享参数，如分享的标题、图标、链接地址等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getShareOptions(): PlusWebviewWebviewShareOptions; + /** + * 获取Webview窗口的样式 + * 获取Webview窗口的样式属性，如窗口位置、大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getStyle(): PlusWebviewWebviewStyles; + /** + * 获取Webview窗口的原生子View控件对象 + * 创建Webview窗口的所有原生子View控件。 + * 可以在创建窗口时设置其subNViews属性自动创建（应用首页可通过manfest.json中的plus->launchwebview->subNNViews节点配置创建）； + * 也可以通过Webview窗口的append方法将已经创建的原生View控件添加为其子。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getSubNViews(): PlusNativeObjView []; + /** + * 获取Webview窗口加载HTML页面的标题 + * 标题为HTML页面head节点下title节点中的文本内容，当窗口内容发生页面内跳转时可通过窗口触发的“loaded”事件中调用此方法来获取跳转后页面的标题。 + * 如果HTML页面没有使用title节点来设置标题，则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getTitle(): string; + /** + * 获取Webview窗口的标题栏控件对象 + * 创建Webview窗口时设置其titleNView属性时则自动创建标题栏控件，应用首页可通过manfest.json中的plus->launchwebview->titleNView节点配置创建标题栏控件。 + * 可通过此方法获取Webview窗口创建的标题栏控件，对象类型为plus.nativeObj.View，可通过调用其drawBitmap/drawRect/drawText方法绘制更新内容来实现自定义样式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getTitleNView(): PlusNativeObjView; + /** + * 获取标题栏上输入框的内容 + * 仅在窗口使用原生标题栏（titleNView）并配置显示搜索框（searchInput）时生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getTitleNViewSearchInputText(): string; + /** + * 获取Webview窗口加载HTML页面的地址 + * 当窗口内容发生页面内跳转时可通过窗口触发的“loaded”事件中调用此方法来获取跳转后页面的地址。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + getURL(): string; + /** + * 隐藏Webview窗口 + * 隐藏Webview窗口可保存已加载HTML页面的上下文数据，能降低应用使用的系统资源，通过show方法可将隐藏的Webview窗口显示出来。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + hide(aniHide?: 'auto' | 'none' | 'slide-out-right' | 'slide-out-left' | 'slide-out-top' | 'slide-out-bottom' | 'fade-out' | 'zoom-in' | 'zoom-fade-in' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-backward' | 'pop-out', duration?: number, extras?: PlusWebviewWebviewExtraOptions): void; + /** + * 隐藏标题栏上按钮的红点 + * 仅在窗口使用原生标题栏（titleNView）时生效，未显示原生标题栏时操作此接口无任何效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + hideTitleNViewButtonRedDot(options: PlusWebviewHideTitleNViewButtonRedDotOptions): void; + /** + * 是否拦截Webview窗口的触屏事件 + * 拦截后触屏事件不再传递，否则传递给View控件下的其它窗口处理。 + * Webview窗口默认拦截所有触屏事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + interceptTouchEvent(intercept?: boolean): void; + /** + * 查询Webview窗口是否开启硬件加速 + * 如果Webview窗口已经开启硬件加速则返回true，否则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + isHardwareAccelerated(): boolean; + /** + * 查询Webview窗口是否暂停 + * 如果Webview窗口已经暂停则返回true，否则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + isPause(): boolean; + /** + * 查询Webview窗口是否可见 + * 若Webview窗口已经显示（调用过show方法，即使被其它窗口挡住了也认为已显示）则返回true，若Webview窗口被隐藏则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + isVisible(): boolean; + /** + * 监听页面开始加载资源 + * Webview加载资源时，如果满足options参数中定义的条件，则触发callback回调。 + * 此方法仅触发回调事件，不会阻止资源的加载。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + listenResourceLoading(options?: PlusWebviewWebviewListenResourceOptions, callback?: (result: any) => void): void; + /** + * 加载新HTML数据 + * 触发Webview窗口加载HTML页面数据，如果HTML数据无效将导致页面加载失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + loadData(data: string, options?: PlusWebviewWebviewLoadDataOptions): void; + /** + * 加载新URL页面 + * 触发Webview窗口从新的URL地址加载页面，如果url地址无效将导致页面显示失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + loadURL(url: string, additionalHttpHeaders?: any): void; + /** + * 获取Webview窗口对象的原生（Native.JS）实例对象 + * Android平台返回Webview窗口对象的android.webkit.Webview实例对象， + * iOS平台返回Webview窗口对象的UIWebview实例对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + nativeInstanceObject(): PlusAndroidInstanceObject | PlusIosInstanceObject; + /** + * 获取在当前Webview窗口中创建的所有窗口 + * 返回从当前Webview中调用plus.webview.open或plus.webview.create创建的所有Webview窗口数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + opened(): PlusWebviewWebviewObject []; + /** + * 获取当前Webview窗口的创建者 + * 创建者为调用plus.webview.open或plus.webview.create方法创建当前窗口的Webview窗口。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + opener(): PlusWebviewWebviewObject; + /** + * 拦截Webview窗口的资源加载 + * 根据区配规则拦截Webview窗口加载资源的URL地址，重定向到其它资源地址（暂仅支持本地地址）。 + * 注意：多次调用overrideResourceRequest时仅以最后一次调用设置的参数值生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + overrideResourceRequest(options?: PlusWebviewWebviewOverrideResourceOptions []): void; + /** + * 拦截Webview窗口的URL请求 + * 拦截URL请求后，Webview窗口将不会跳转到新的URL地址，此时将通过callback回调方法返回拦截的URL地址（可新开Webview窗口加载URL页面等）。 + * 此方法只能拦截窗口的网络超链接跳转（包括调用loadURL方法触发的跳转），不可拦截页面请求资源请求（如加载css/js/png等资源的请求）。 + * 注意：多次调用overrideUrlLoading时仅以最后一次调用设置的参数值生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + overrideUrlLoading(options?: PlusWebviewWebviewOverrideUrlOptions, callback?: (result: any) => void): void; + /** + * 获取当前Webview窗口的父窗口 + * Webview窗口作为子窗口添加（Webview.append）到其它Webview窗口中时有效，这时其它Webview窗口为父窗口。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + parent(): PlusWebviewWebviewObject; + /** + * 暂停当前Webview窗口 + * Webview窗口的js停止运行，页面内容不再更新渲染。 + * 应用中存在多个Webview窗口时，可以停止不显示的Webview，减少对系统资源的占用。 + * 注意：暂停后在窗口显示时需调用resume恢复。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + pause(): void; + /** + * 重新加载Webview窗口显示的HTML页面 + * 触发Webview窗口重新加载当前显示的页面内容。 + * 如果当前HTML页面未加载完则停止并重新加载，如果当前Webview窗口没有加载任何页面则无响应。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + reload(force: boolean): void; + /** + * 重置Webview窗口的回弹位置 + * 开启窗口回弹效果后，当窗口中展现的内容滚动到头（顶部或底部）时，再拖拽时窗口整体内容将跟随移动，松开后自动回弹到停靠位置。 + * 这时需要调用此方法来重置窗口的回弹位置，窗口将采用动画方式回弹到其初始显示的位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + resetBounce(): void; + /** + * 恢复Webview控件显示内容 + * 恢复调用animate方法改变Webview控件的内容，更新至动画前显示的内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + restore(): void; + /** + * 移除子Webview窗口 + * 从当前Webview窗口移除指定的子Webview窗口，若指定的webview对象不是当前窗口的子窗口则无任何作用。 + * 移除后子Webview窗口不会关闭，需要调用其close方法才能真正关闭并销毁。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + remove(webview: PlusNativeObjView | PlusWebviewWebviewObject): void; + /** + * 移除Webview窗口事件监听器 + * 从Webview窗口移除通过addEventListener方法添加的事件监听器，若没有查找到对应的事件监听器，则无任何作用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + removeEventListener(event: PlusWebviewWebviewEvent, listener: (result: any) => void): void; + /** + * 从父窗口中移除 + * 从所属的父Webview窗口移除，如果没有父窗口，则无任何作用。 + * 从父窗口中移除后子Webview窗口不会关闭，需要调用其close方法才能真正关闭并销毁。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + removeFromParent(): void; + /** + * 移除标题栏上按钮的角标 + * 仅在窗口使用原生标题栏（titleNView）时生效，未显示原生标题栏时操作此接口无任何效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + removeTitleNViewButtonBadge(options: PlusWebviewRemoveTitleNViewButtonBadgeOptions): void; + /** + * 恢复当前Webview窗口 + * Webview窗口暂停后，调用此方法恢复js运行及页面内容的更新渲染。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + resume(): void; + /** + * 设置Webview窗口的回弹效果 + * 开启窗口回弹效果后，当窗口中展现的内容滚动到头（顶部或底部）时，再拖拽时窗口整体内容将跟随移动，松开后自动回弹到停靠位置（可通过style设置）。 + * 拖拽窗口内容时页面显示Webview窗口的背景色，默认为透明，此时显示Webview下面的内容，利用这个特点可以实现自定下拉刷新特效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setBounce(style: PlusWebviewWebviewBounceStyle): void; + /** + * 设置Webview窗口是否阻塞加载页面中使用的网络图片 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setBlockNetworkImage(block: boolean): void; + /** + * 设置HTML内容是否可见 + * 设置HTML内容不可见后，将显示Webview窗口的背景色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setContentVisible(visible: boolean): void; + /** + * 设置预加载的CSS文件 + * 预加载CSS文件不需要在HTML页面中显式引用，在Webview窗口加载HTML页面时自动加载，在页面跳转时也会自动加载。 + * 设置新的CSS文件后将清空之前设置的值（包括调用setCssText设置的值）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setCssFile(file: string): void; + /** + * 设置预加载的CSS内容 + * 预加载CSS内容不需要在HTML页面中显式引用，在Webview窗口加载HTML页面时自动加载，在页面跳转时也会自动加载。 + * 设置新的CSS内容后将清空之前设置的值（包括调用setCssFile设置的值）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setCssText(text: string): void; + /** + * 设置Webview窗口的收藏参数 + * 仅在流应用环境（流应用/5+浏览器）中有效：用户点击流应用环境的收藏按钮时使用的参数，如设置收藏页面标题，图标、页面地址等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setFavoriteOptions(options: PlusWebviewWebviewFavoriteOptions): void; + /** + * 设置Webview窗口底部修复区域高度 + * 如果Webview加载页面中存在底部停靠区域（如“蘑菇街”WAP页面的底部Tab栏），在页面滚动时动态改变Webview高度可能会出现底部停靠区域抖动的现象（如360浏览器中向上滑顶部标题栏自动消失引起Webview变高）。 + * 此时可以调用此方法来指定底部停靠区域（通常是底部Tab栏）进行优化修复抖动效果，高度值为底部停靠区域的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setFixBottom(height: number): void; + /** + * 设置预加载的JS文件 + * 预加载JS文件不需要在HTML页面中显式引用，在Webview窗口加载HTML页面时自动加载，在页面跳转时也会自动加载。 + * 设置新的JS文件后将清空之前设置的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setJsFile(file: string): void; + /** + * 设置Webview窗口的下拉刷新效果 + * 开启Webview窗口的下拉刷新功能，显示窗口内置的下拉刷新控件样式。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setPullToRefresh(style: PlusWebviewWebviewPullToRefreshStyles, refreshCB: () => void): void; + /** + * 设置Webview窗口rendered事件参数 + * 可设置页面渲染完成的判断标准，如判断页面顶部区域、中间区域、或底部区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setRenderedEventOptions(options: PlusWebviewWebviewRenderedEventOptions): void; + /** + * 临时设置弹出系统软键盘样式 + * 仅生效一次，设置后第一次弹出软键盘时生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setSoftinputTemporary(options: PlusWebviewSetSoftinputTemporaryOptions): void; + /** + * 设置Webview窗口的样式 + * 更新Webview窗口的样式，如窗口位置、大小、背景色等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setStyle(styles: PlusWebviewWebviewStyles): void; + /** + * 设置Webview窗口的分享参数 + * 仅在流应用环境（流应用/5+浏览器）中有效：用户点击流应用环境的分享按钮时使用的参数，如设置分享的标题、链接地址等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setShareOptions(options: PlusWebviewWebviewShareOptions): void; + /** + * 设置标题栏上按钮的角标 + * 仅在窗口使用原生标题栏（titleNView）时生效，未显示原生标题栏时操作此接口无任何效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setTitleNViewButtonBadge(options: PlusWebviewSetTitleNViewButtonBadgeOptions): void; + /** + * 设置标题栏上按钮的样式 + * 仅在窗口使用原生标题栏（titleNView）时生效，未显示原生标题栏时操作此接口无任何效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setTitleNViewButtonStyle(index: number, styles: PlusWebviewWebviewTitleNViewButtonStyles): void; + /** + * 设置标题栏上输入框是否获取输入焦点 + * 仅在窗口使用原生标题栏（titleNView）并配置显示搜索框（searchInput）时生效，未显示原生标题栏时操作此接口无任何效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setTitleNViewSearchInputFocus(focus: boolean): void; + /** + * 设置标题栏上输入框的内容 + * 如果要清空用户输入的内容，可以设置为空字符串。 + * 仅在窗口使用原生标题栏（titleNView）并配置显示搜索框（searchInput）时生效，未显示原生标题栏时操作此接口无任何效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setTitleNViewSearchInputText(text: string): void; + /** + * 设置Webview窗口是否可见 + * 修改窗口是否可见并不影响窗口的显示栈顺序，窗口显示与隐藏也不会有动画效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + setVisible(visible: boolean): void; + /** + * 显示Webview窗口 + * 当调用plus.webview.create方法创建Webview窗口后，需要调用其show方法才能显示，并可设置窗口显示动画及动画时间。 + * Webview窗口被隐藏后也可调用此方法来重新显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + show(aniShow?: 'auto' | 'none' | 'slide-in-right' | 'slide-in-left' | 'slide-in-bottom' | 'fade-in' | 'zoom-out' | 'zoom-fade-out' | 'flip-x' | 'flip-rx' | 'flip-y' | 'flip-ry' | 'page-forward' | 'pop-in', duration?: number, showedCB?: () => void, extras?: PlusWebviewWebviewExtraOptions): void; + /** + * 在指定Webview窗口后显示 + * 当调用plus.webview.create方法创建Webview窗口后，可调用其showBehind方法显示在指定Webview窗口之后。 + * 这种显示方式不会出现动画效果，当指定的Webview窗口关闭后，则自身窗口自动显示出来。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + showBehind(webview?: PlusWebviewWebviewObject): void; + /** + * 设置标题栏上按钮的红点 + * 仅在窗口使用原生标题栏（titleNView）时生效，未显示原生标题栏时操作此接口无任何效果。 + * 注意：设置显示按钮的角标后红点不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + showTitleNViewButtonRedDot(options: PlusWebviewShowTitleNViewButtonRedDotOptions): void; + /** + * 停止加载HTML页面内容 + * 触发Webview窗口停止加载页面内容，如果已经加载部分内容则显示部分内容，如果加载完成则显示全部内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + stop(): void; + /** + * 更新Webview窗口的原生子View控件对象 + * 通过WebviewSubNViewStyles中的id属性值匹配子View控件更新绘制内容，如果没有查找到对应id的子View控件则忽略。 + * 此操作仅更新子View控件上绘制的内容，不会添加或删除原生子View控件对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + updateSubNViews(styles: PlusWebviewWebviewSubNViewStyles []): void; +} + +/** + * Webview窗口动画参数 + * 用于指定动画目标窗口，起始位置、目标位置等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewAnimationOptions { + /** + * 执行动画的窗口对象 + * 可取值Webview窗口对象、Webview窗口的id（String类型）、原生View窗口对象（plus.nativeObj.View）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + view?: PlusWebviewWebviewObject; + /** + * 动画样式 + * 用于指定动画窗口的起始位置，目标位置等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + styles?: PlusWebviewWebviewAnimationStyles; + /** + * 窗口动画完成后的行为 + * 可取值： + * "none" - 动画完成后不做任何操作； + * "hide" - 动画完成后隐藏窗口； + * "close" - 动画完成后关闭窗口。 + * 默认值为"none"。 + * - none: 动画完成后不做任何操作 + * - hide: 动画完成后隐藏窗口 + * - close: 动画完成后关闭窗口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + action?: 'none' | 'hide' | 'close'; +} + +/** + * Webview窗口动画样式 + * 用于指定动画窗口的起始位置、目标位置等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewAnimationStyles { + /** + * 画窗口的起始左侧位置 + * 支持百分比、像素值，默认值为当前窗口的位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + fromLeft?: string; + /** + * 画窗口的目标左侧位置 + * 持百分比、像素值。 + * 注意：如果设置的位置与起始位置一直，则无动画效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + toLeft?: string; +} + +/** + * Webview窗口回弹样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewBounceStyle { + /** + * Webview窗口支持回弹效果的方向 + * 可通过此参数设置开启Webview哪个方向支持回弹效果。 + * 支持以下属性： + * top：表示窗口顶部支持回弹效果； + * left：表示窗口左侧支持回弹效果； + * right：表示窗口右侧支持回弹效果； + * bottom：表示窗口底部支持回弹效果。 + * **目前仅支持top属性** + * 属性值：用于指定可拖拽的范围，可取百分比，如"10%"；像素值，如"100px"；自动计算值，如"auto"；无回弹效果值，如"none"； + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + position?: any; + /** + * Webview窗口回弹时停靠的位置 + * 开启窗口回弹效果后，当窗口中展现的内容滚动到头（顶部或底部）时，再拖拽时窗口整体内容将跟随移动，拖拽过程中将触发"dragBounce"事件，松开后自动回弹到停靠位置。 + * 支持以下属性： + * top：表示窗口顶部回弹时停靠的位置。 + * 属性值：用于指定窗口回弹的位置，可取百分比，如"5%"；像素值，如"100px"；自动计算值，如"auto"，默认为可拖拽的范围值的一半； + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + changeoffset?: any; + /** + * Webview窗口侧滑时停靠的位置 + * 开启窗口回弹效果后，当窗口中展现的内容滚动到头（左侧或右侧）时，在拖拽时窗口整体内容将跟随移动，松开后自动停靠的侧滑位置，并触发"slideBounce"事件。 + * 支持以下属性： + * left：表示窗口左侧侧滑的位置； + * right：表示窗口右侧侧滑的位置。 + * 属性值：用于指定滑动后停靠的距离，可取百分比（left/right相对于窗口的宽度，top/bottom相对于窗口的高度），如"30%"；像素值，如"100px"；自动计算值，为可拖拽范围，如"auto"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + slideoffset?: any; + /** + * Webview窗口拖拽偏移的位置 + * 开启窗口回弹效果后，可以通过此属性值来主动设置拖拽的偏移位置，与手动操作拖拽至此偏移位置松开后的逻辑一致。 + * 支持以下属性： + * top：表示窗口顶部偏移的位置； + * left：表示窗口左侧偏移的位置； + * right：表示窗口右侧偏移的位置； + * bottom：表示窗口底部偏移的位置。 + * 属性值：用于指定偏移的位置，可取百分比，如"5%"；像素值，如"100px"；有效值范围为0到position属性定义的位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + offset?: any; + /** + * Webview窗口是否阻止touch事件传递给DOM元素 + * 设置为true表示阻止touch事件，设置为false表示不阻止touch事件。当开启侧滑功能（左侧滑和右侧滑）时默认值为true，否则为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + preventTouchEvent?: boolean; +} + +/** + * Webview窗口内容动画参数 + * 指定动画的类型、持续时间等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewContentAnimationOptions { + /** + * 动画类型 + * 可取值："shrink" - 从上到下分块收缩清除窗口动画。 + * - shrink: 从上到下分块清除动画 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + type?: 'shrink'; + /** + * 动画持续时间 + * 单位为毫秒，默认值为200ms。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + duration?: number; + /** + * 动画帧数 + * 必须为大于0的整数，默认值为12。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + frames?: number; + /** + * 动画作用区域 + * 支持以下属性： + * top - 区域距离控件顶部的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的高度）,默认值为'0px'； + * bottom - 区域距离控件底部的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的高度）,默认值为'0px'； + * left - 区域距离控件左侧的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的宽度）,默认值为'0px'； + * right - 区域距离控件右侧的偏移量，属性值可取像素值（如"100px"），百分比（如"10%"，相对于控件的宽度）,默认值为'0px'。 + * 如“{top:'44px',bottom:'48px'}”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + region?: any; +} + +/** + * 原生控件在窗口中停靠的方式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewDock { + /** + * 控件停靠则页面顶部 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + top?: string; + /** + * 控件停靠在页面底部 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + bottom?: string; + /** + * 控件停靠在页面右侧 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + right?: string; + /** + * 控件停靠在页面左侧 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + left?: string; +} + +/** + * Webview窗口滑动事件数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewDragEvent { + /** + * 手势类型 + * 可取值： + * "rtl" - 从右向左滑动手势； + * "left" - 向左滑动手势，与rtl一致； + * "ltr" - 从左向右滑动手势； + * "right" - 向右滑动手势，与ltr一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + direction?: string; + /** + * 窗口滑动类型 + * 可取值： + * "start" - 表示开始滑动操作； + * "move" - 表示正在滑动； + * "end" - 表示滑动操作结束。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + type?: string; + /** + * 窗口滑动结果 + * 可取值： + * "true" - 表示滑动操作成功； + * "false" - 表示滑动操作失败（恢复到滑动前的状态）； + * "undefined" - 无状态值（当type值为"end"时返回此值）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + result?: string; + /** + * 当前操作窗口标识 + * 当type值为"start"/"move"时，保存当前操作窗口（或View控件）的标识； + * 当type值为"end"时保存滑动操作后显示窗口（或View控件）的标识（即result值为"true"则认为关联窗口显示，result值为false则认为主窗口显示）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + id?: string; + /** + * 关联窗口标识 + * 滑动操作关联窗口（或View控件）的标识。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + otherId?: string; + /** + * 主窗口标识 + * 滑动操作主窗口（或View控件）的标识。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + targetId?: string; + /** + * 滑动进度 + * 滑动进度位置信息，取值范围为0-100，如20表示滑动了总距离的20%： + * 当type值为"start"时progress值为0； + * 当type值为"end"时如果result为true则progress值为0，如果result为false则progress值为100； + * 当type值为"move"时，保存当前滑动的进度信息（注：多次触发move事件）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + progress?: number; +} + +/** + * 窗口手势操作参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewDragOptions { + /** + * 滑屏操作回调事件触发步长 + * 用于设置滑屏回调事件触发频率，取值范围为1-100，值越小触发频率越高，值越大触发频率越小，默认值为20。 + * 如设置值为20，则表示滑屏操作移动距离超过可移动范围的20%则触发一次回调事件，可通过回调函数参数（WebviewDragEvent）的progress属性获取。 + * 注意：触发频率过大会影响效率，开发者需谨慎设置此值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + callbackStep?: number; + /** + * 设置的手势类型 + * 可取值： + * 可取值： + * "rtl" - 从右向左滑动手势； + * "left" - 向左滑动手势，与rtl一致； + * "ltr" - 从左向右滑动手势； + * "right" - 向右滑动手势，与ltr一致。 + * - rtl: 从右向左滑动手势 + * - left: 向左滑动手势，与rtl一致 + * - ltr: 从左向右滑动手势 + * - right: 向右滑动手势，与ltr一致 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + direction?: 'rtl' | 'left' | 'ltr' | 'right'; + /** + * 滑动手势模式 + * 可取值： + * "followFinger" - 当前Webview窗口跟随手指滑动； + * "silent" - 当前Webview窗口不跟随手指滑动； + * "bounce" - 当前Webview窗口自动回弹（松手后窗口恢复到拖动前的位置）,通常可通过设置此模式来实现Tab项无法继续滑动切换自动回弹效果。 + * - followFinger: 当前Webview窗口跟随手指滑动 + * - silent: 当前Webview窗口不跟随手指滑动 + * - bounce: 当前Webview窗口自动回弹 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + moveMode?: 'followFinger' | 'silent' | 'bounce'; +} + +/** + * 手势操作关联对象参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewDragOtherViewOptions { + /** + * 手势关联对象 + * 可取值Webview窗口的id（String类型）、Webview窗口对象、原生View窗口对象（plus.nativeObj.View）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + view?: string; + /** + * 滑动模式 + * 可取值： + * "follow" - 同步跟随主Webview窗口滑动； + * "silent" - 不跟随主Webview窗口滑动。 + * - follow: 同步跟随主Webview窗口滑动 + * - silent: 不跟随主Webview窗口滑动 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + moveMode?: 'follow' | 'silent'; +} + +/** + * 截屏绘制操作参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewDrawOptions { + /** + * 截屏图片的位深 + * 可取值： + * "RGB565" - RGB565彩色模式,一个像素占两个字节； + * "ARGB" - ARGB彩色模式,保存透明度信息。 + * - RGB565: + * RGB565彩色模式,一个像素占两个字节。 + * + * - ARGB: + * ARGB彩色模式,保存透明度信息。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + bit?: 'RGB565' | 'ARGB'; + /** + * 是否检测截屏图片是否为空白 + * 可取值： + * true - 表示检测到截屏到空白图片时认为操作失败（触发错误回调函数）； + * false - 表示不检测，即使为空白图片仍然返回成功。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + check?: boolean; + /** + * 设置截屏区域 + * 相对于Webview窗口的区域信息，默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + clip?: PlusNativeObjRect; + /** + * 是否检测当前是否弹出软键盘 + * 可取值： + * true - 表示检测到弹出软键盘是认为截屏操作失败（触发错误回调函数）； + * false - 表示不检测软键盘状态，直接截屏。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + checkKeyboard?: boolean; +} + +/** + * 窗口收藏参数 + * 在流应用环境中调用收藏功能时使用的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewFavoriteOptions { + /** + * 收藏时显示的图标 + * 在收藏列表中显示的图标，默认使用应用图标。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + icon?: string; + /** + * 收藏时显示的标题 + * 在收藏列表中显示的标题字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + title?: string; + /** + * 收藏的页面地址 + * 必须是网络地址。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + href?: string; +} + +/** + * 创建加载HTML数据参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewLoadDataOptions { + /** + * 页面的Base URL + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + baseURL?: string; + /** + * HTML数据的数据类型 + * 默认值为"text/html"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + mimeType?: string; + /** + * HTML数据的编码类型 + * 默认值为"utf-8"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + encoding?: string; +} + +/** + * 窗口的分享参数 + * 在流应用环境中调用分享功能时使用的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewShareOptions { + /** + * 分享时使用的图标 + * 默认使用应用图标。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + icon?: string; + /** + * 分享时使用的标题 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + title?: string; + /** + * 分享时使用的链接地址 + * 必须是网络地址。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + href?: string; +} + +/** + * 窗口原生子View控件样式 + * 可设置原生控件的标识、大小、位置以及绘制的内容等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewSubNViewStyles { + /** + * 原生子View控件的标识 + * 可通过plus.nativeObj.View.getViewById(id)方法传入此标识来获取子View控件对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + id?: string; + /** + * 原生子View控件类型 + * 可取值： + * "NView" - 原生子View控件（plus.nativeObj.NView）； + * "ImageSlider" - 原生图片轮播控件（plus.nativeObj.ImageSlider）。 + * 默认值为"NView"。 + * - NView: + * 原生子View控件（plus.nativeObj.NView） + * + * - ImageSlider: + * 原生图片轮播控件（plus.nativeObj.ImageSlider） + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + type?: 'NView' | 'ImageSlider'; + /** + * 原生子View控件的样式 + * 可设置原生控件的位置、大小等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + styles?: PlusNativeObjViewStyles; + /** + * 原生子View控件初始绘制内容 + * 可设置绘制图片、矩形区域、文本等内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + tags?: PlusNativeObjViewDrawTagStyles []; +} + +/** + * 窗口标题栏控件样式 + *

+ * 标题栏控件固定高度为44px,可通过Webview窗口对象的getTitleNView方法获取标题栏原生控件对象plus.nativeObj.View，调用其方法绘制自定义内容。 + * 可以通过WebviewObject对象的setStyle方法传入titleNView属性更新样式，如wobj.setStyle({titleNView:{titleColor:'#FF0000'}})。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewTitleNViewStyles { + /** + * 标题栏控件是否显示左侧返回按钮 + * 可取值： + * "true" - 显示返回按钮； + * "false" - 不显示返回按钮。 + * 默认值为"false"。 + * 返回按钮的颜色为窗口标题文字颜色，按下时颜色自动调整透明度为0.3。 + * 点击返回按钮的逻辑与按下系统返回键逻辑一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + autoBackButton?: boolean; + /** + * 标题栏控件的返回按钮的样式 + *

+ * 当autoBackButton设置为true时生效。 + * 通过此属性可自定义返回按钮样式，如图标大小、红点、角标、标题等。 + * 注意：HBuilderX2.6.3+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backButton?: PlusWebviewWebviewTitleNViewBackButtonStyles; + /** + * 标题栏控件的背景颜色 + * 颜色值格式为"#RRGGBB"，如"#FF0000"表示为红色背景； + * "rgba(R,G,B,A)"，如rgba(255,0,0,0.5)表示半透明红色背景。 + * 默认值为"#F7F7F7"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backgroundColor?: string; + /** + * 设置标题栏的背景图 + *

+ * 支持以下类型： + * 背景图片路径 - 如"./img/t.png"，仅支持本地文件路径， 相对路径，相对于当前页面的host位置，根据实际标题栏宽高拉伸绘制； + * 渐变色 - 仅支持线性渐变，两种颜色的渐变，如“linear-gradient(to top, #a80077, #66ff00)”， + * 其中第一个参数为渐变方向，可取值： "to right"表示从左向右渐变， + * “to left"表示从右向左渐变， + * “to bottom"表示从上到下渐变， + * “to top"表示从下到上渐变， + * “to bottom right"表示从左上角到右下角， + * “to top left"表示从右下角到左上角。 + * 默认无渐变效果，设置错误格式数据也无渐变效果。 + * 注意：HBuilderX2.6.3+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backgroundImage?: string; + /** + * 设置标题栏的背景图平铺方式 + *

+ * 仅在backgroundImage设置为图片路径时有效。 + * 可取值： + *

    + *
  • "repeat" - 背景图片在垂直方向和水平方向平铺
    • + *
  • "repeat-x" - 背景图片在水平方向平铺，垂直方向拉伸
    • + *
  • "repeat-y" - 背景图片在垂直方向平铺，水平方向拉伸
    • + *
  • "no-repeat" - 背景图片在垂直方向和水平方向都拉伸
    • + *
+ * 默认值为"no-repeat"。 + * 注意：HBuilderX2.6.3+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backgroundRepeat?: string; + /** + * 模糊（毛玻璃）效果 + *

+ * 此效果将会高斯模糊显示标题栏后的内容，仅在type为"transparent"或"float"时有效。 + * 可取值： + *

    + *
  • "dark" - 暗风格模糊，对应iOS原生UIBlurEffectStyleDark效果
    • + *
  • "extralight" - 高亮风格模糊，对应iOS原生UIBlurEffectStyleExtraLight效果
    • + *
  • "light" - 亮风格模糊，对应iOS原生UIBlurEffectStyleLight效果
    • + *
  • "none" - 无模糊效果
    • + *
+ * HBuilderX2.4.3+版本支持，默认值为"none"。 + * 注意：使用模糊效果时应避免设置背景颜色，设置背景颜色可能覆盖模糊效果。 + *

+ * - dark: 暗风格模糊效果 + * - extralight: 高亮风格模糊效果 + * - light: 亮风格模糊效果 + * - extralight: 无模糊效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + blurEffect?: 'dark' | 'extralight' | 'light' | 'extralight'; + /** + * 标题栏上的自定义按钮 + * 创建的自定义按钮数目不限制，实际应用中建议最多设置4个按钮（包括左侧返回按钮）。 + * 注意：此属性不支持动态修改，仅在创建titleNView时设置有效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + buttons?: PlusWebviewWebviewTitleNViewButtonStyles []; + /** + * 标题栏控件变化作用范围 + * 仅在type值为transparent时有效，页面滚动时标题栏背景透明度将发生变化。 + * 当页面滚动到指定偏移量时标题栏背景变为完全不透明。 + * 支持百分比、像素值，默认为'132px'。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + coverage?: string; + /** + * 标题栏控件是否显示Home按钮 + * 可取值： + * "true" - 显示Home按钮； + * "false" - 不显示Home按钮。 + * 默认值为"false"。 + * Home按钮的颜色为窗口标题文字颜色，按下时颜色自动调整透明度为0.3。 + * 点击Home按钮的逻辑为关闭所有非首页窗口，显示首页窗口。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + homeButton?: boolean; + /** + * 内边距 + * 标题栏左右的内边距，单位为px（逻辑像素值），如"10px"表示10逻辑像素值。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + padding?: string; + /** + * 右内边距 + * 标题栏右侧内边距，单位为px（逻辑像素值），如"10px"表示10逻辑像素值。 + * 默认值为"0px"，优先级padding-right > padding。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'padding-right'?: string; + /** + * 左内边距 + * 标题栏左侧内边距，单位为px（逻辑像素值），如"10px"表示10逻辑像素值。 + * 默认值为"0px"，优先级padding-left > padding。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + 'padding-left'?: string; + /** + * 标题栏控件的进度条样式 + * 设置此属性则在标题栏控件的底部显示进度条，可配置进度条颜色值即高度。 + * 设置此属性值为undefined或null则隐藏进度条。 + * 默认不显示底部进度条。 + * 注意：此属性将废弃，推荐使用WebviewStyles的progress。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + progress?: PlusWebviewWebviewProgressStyles; + /** + * 标题栏控件上按钮的红点颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示绘制红色返回键； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为红色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + redDotColor?: string; + /** + * 标题栏上的搜索框样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + searchInput?: PlusWebviewWebviewTitleNViewSearchInputStyles; + /** + * 标题栏的底部分割线 + *

+ * 设置此属性则在标题栏控件的底部显示分割线，可配置颜色值及高度。 + * 设置此属性值为undefined或null则隐藏分割线。 + * 默认不显示底部分割线。 + * 注意：HBuilderX2.6.6+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + splitLine?: PlusWebviewWebviewSplitLineStyles; + /** + * 副标题文字颜色 + *

+ * 颜色值格式为"#RRGGBB"和"rgba(R,G,B,A)"，如"#FF0000"表示标题文字颜色为红色。 + * 默认值与主标题文字颜色一致。 + * 注意：HBuilderX2.6.6+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + subtitleColor?: string; + /** + * 副标题文字字体大小 + *

+ * 字体大小单位为像素，如"14px"表示字体大小为14像素，默认值为12像素。 + * 注意：HBuilderX2.6.6+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + subtitleSize?: string; + /** + * 标题文字超出显示区域时处理方式 + *

+ * 可取值： + *

    + *
  • "clip" - 超出显示区域时内容裁剪
    • + *
  • "ellipsis" - 超出显示区域时尾部显示省略标记（...）
    • + *
+ * 默认值为"ellipsis"。 + * 注意：HBuilderX2.6.6+版本支持。 + *

+ * - clip: 超出显示区域时内容裁剪 + * - ellipsis: 超出显示区域时尾部显示省略标记（...） + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + subtitleOverflow?: 'clip' | 'ellipsis'; + /** + * 副标题文字内容 + *

+ * 设置副标后将显示两行标题，副标显示在主标题（titleText）下方。 + * 注意：HBuilderX2.6.6+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + subtitleText?: string; + /** + * 标题栏上初始自定义绘制内容 + * 可用于设置自定义绘制图片、矩形区域、文本等内容。 + * 注意：此属性不支持动态修改，仅在创建titleNView时设置有效，如果需要更新绘制内容可根据tags的id调用draw方法操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + tags?: PlusNativeObjViewDrawTagStyles []; + /** + * 标题对齐方式 + *

+ * 可取值： + *

    + *
  • "center"-居中对齐
    • + *
  • "left"-居左对齐
    • + *
  • "auto"-根据平台自动选择（Android平台居左对齐，iOS平台居中对齐）
    • + *
+ * 注意：HBuilderX2.6.3+版本支持。 + *

+ * - center: 居中对齐 + * - left: 居左对齐 + * - auto: 根据平台自动选择（Android平台居左对齐，iOS平台居中对齐） + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleAlign?: 'center' | 'left' | 'auto'; + /** + * 标题文字颜色 + * 颜色值格式为"#RRGGBB"和"rgba(R,G,B,A)"，如"#FF0000"表示标题文字颜色为红色。 + * type=transparent时默认值为"#FFFFFF"，其它情况默认值为"#000000"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleColor?: string; + /** + * 标题图标 + *

+ * 图标路径如"./img/t.png"，相对路径，相对于当前页面的host位置，默认宽高为逻辑像素值"34px"。 + * HBuilderX2.6.9+版本支持网络路径（http/https开头的url链接）； + * HBuilderX2.6.12+版本支持base64图片。 + * 注意：要求图片的宽高相同。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleIcon?: string; + /** + * 标题图标圆角 + * 取值格式为"XXpx"，其中XX为像素值（逻辑像素），如"10px"表示10像素半径圆角。 + * 默认值为无圆角。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleIconRadius?: string; + /** + * 标题图标宽度 + *

+ * 取值格式为"XXpx"，其中XX为像素值（逻辑像素），如"10px"表示图标宽度为10像素，图标高度会自动与图标宽度保持一致，默认值为"34px"。 + * HBuilderX2.7.6+版本支持设置图标宽度。 + * 注意：图标在标题栏垂直居中。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleIconWidth?: string; + /** + * 标题文字超出显示区域时处理方式 + * 可取值： + * "clip" - 超出显示区域时内容裁剪； + * "ellipsis" - 超出显示区域时尾部显示省略标记（...）。 + * 默认值为"ellipsis"。 + * - clip: 超出显示区域时内容裁剪 + * - ellipsis: 超出显示区域时尾部显示省略标记（...） + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleOverflow?: 'clip' | 'ellipsis'; + /** + * 标题文字字体大小 + * 字体大小单位为像素，如"20px"表示字体大小为20像素，默认值为17像素。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleSize?: string; + /** + * 标题文字内容 + * 在标题栏控件居中（水平和垂直）显示，左右边距为88px，如果文本过长则尾部裁剪（加三个点"..."）显示。 + * 当不设置titleText属性或属性值为undefined/null时，使用当前Webview窗口加载页面的标题，并自动同步更新页面的标题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleText?: string; + /** + * 标题栏控件样式 + *

+ * 可取值： + *

    + *
  • "default" - 默认样式，顶部停靠显示，挤压Webview页面内容显示区域
    • + *
  • "transparent" - 透明样式，顶部沉浸式显示覆盖Webview页面内容，标题栏上内容（除按钮外）全部透明，当页面滚动时透明度逐渐变化，直到不透明显示
    • + *
  • "float" - 悬浮样式，顶部悬浮显示，标题栏覆盖在Webview上，此时应该设置标题栏背景颜色（backgroundColor）为半透明才能透视到覆盖Webview的内容
    • + *
+ * 默认值为"default"。 + * 注意：此属性不支持动态更新。 + *

+ * - default: + * 默认样式，顶部停靠显示，挤压Webview页面内容显示区域 + * + * - transparent: + * 透明样式，顶部沉浸式显示覆盖Webview页面内容，标题栏上内容（除按钮外）全部透明，当页面滚动时透明度逐渐变化，直到不透明显示 + * + * - float: + * 悬浮样式，顶部悬浮显示，标题栏覆盖在Webview上，此时应该设置标题栏背景颜色（backgroundColor）为半透明才能透视到覆盖Webview的内容 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + type?: 'default' | 'transparent' | 'float'; +} + +/** + * 窗口标题栏自定义返回按钮样式 + *

+ * 返回按钮由返回图标（字体图标）和标题组成。 + * 默认只显示返回图标。 + * 注意：HBuilderX2.6.3+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewTitleNViewBackButtonStyles { + /** + * 按钮的背景颜色 + * 仅在标题栏type=transparent时生效，当标题栏透明时按钮显示的背景颜色。 + * 可取值#RRGGBB和rgba格式颜色字符串，默认值为灰色半透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + background?: string; + /** + * 按钮上显示的角标背景颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * 默认值为红色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + badgeBackground?: string; + /** + * 按钮上显示的角标文本颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * 默认值为白色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + badgeColor?: string; + /** + * 按钮上显示的角标字体大小 + * 可取值：字体高度像素值，数字加"px"格式字符串，如"22px"。 + * 默认值为"16px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + badgeSize?: string; + /** + * 按钮上显示的角标文本 + * 最多显示3个字符，超过则显示为...。 + * 注意：角标显示在返回图标之后，覆盖在返回按钮的标题之上。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + badgeText?: string; + /** + * 按钮上返回图标和标题颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为窗口标题栏控件的标题文字颜色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + color?: string; + /** + * 按下状态按钮文字颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为color属性值自动调整透明度为0.3。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + colorPressed?: string; + /** + * 按钮上返回图标的粗细 + * 可取值： + * "normal" - 标准字体； + * "bold" - 加粗字体。 + * 默认值为"normal"。 + * 注意：iOS平台的字体图标不支持加粗。 + * - normal: + * 标准字体 + * + * - bold: + * 加粗字体 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + fontWeight?: 'normal' | 'bold'; + /** + * 按钮上返回图标文字大小 + * 可取值：字体高度像素值，数字加"px"格式字符串，如"22px"。 + * 窗口标题栏为透明样式（type="transparent"）时，默认值为"22px"； + * 窗口标题栏为默认样式（type="default"）时，默认值为"27px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + fontSize?: string; + /** + * 按钮上是否显示红点 + * 设置为true则显示红点，false则不显示红点。默认值为false。 + * 注意：当设置了角标文本时红点不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + redDot?: boolean; + /** + * 返回按钮上的标题 + * 显示在返回图标（字体图标）后，默认为空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + title?: string; + /** + * 返回按钮上标题的粗细 + * 可取值： + * "normal" - 标准字体； + * "bold" - 加粗字体。 + * 默认值为"normal"。 + * - normal: + * 标准字体 + * + * - bold: + * 加粗字体 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleWeight?: 'normal' | 'bold'; + /** + * 返回按钮上标题的字体大小 + * 可取值：字体高度像素值，数字加"px"格式字符串，如"22px"。 + * 默认值为"16px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleSize?: string; +} + +/** + * 窗口标题栏自定义按钮样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewTitleNViewButtonStyles { + /** + * 按钮样式 + * 运行环境中内置按钮样式直接使用，内置样式忽略fontSrc和text属性。 + * 可取值： + * "forward" - 前进按钮； + * "back" - 后退按钮； + * "share" - 分享按钮； + * "favorite" - 收藏按钮； + * "home" - 主页按钮； + * "menu" - 菜单按钮； + * "close" - 关闭按钮； + * "none" - 无样式。 + * 默认值为无样式（"none"），需通过text属性设置按钮上显示的内容、通过fontSrc属性设置使用的字体库。 + * - forward: 前进按钮 + * - back: 后退按钮 + * - share: 分享按钮 + * - favorite: 收藏按钮 + * - home: 主页按钮 + * - menu: 菜单按钮 + * - close: 关闭按钮 + * - none: 无样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + type?: 'forward' | 'back' | 'share' | 'favorite' | 'home' | 'menu' | 'close' | 'none'; + /** + * 按钮的背景颜色 + * 仅在标题栏type=transparent时生效，当标题栏透明时按钮显示的背景颜色。 + * 可取值#RRGGBB和rgba格式颜色字符串，默认值为灰色半透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + background?: string; + /** + * 按钮上显示的角标文本 + * 最多显示3个字符，超过则显示为...。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + badgeText?: string; + /** + * 按钮上文字颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为窗口标题栏控件的标题文字颜色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + color?: string; + /** + * 按下状态按钮文字颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为color属性值自动调整透明度为0.3。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + colorPressed?: string; + /** + * 按钮在标题栏上的显示位置 + * 可取值： + * "right" - 在标题栏中靠右排列显示； + * "left" - 在标题栏中靠左侧排列显示（在返回键后）。 + * 默认值为"right"。 + * 注意：float值不支持动态修改，只能在窗口创建时设置。 + * - right: + * 在标题栏中靠右排列显示 + * + * - left: + * 在标题栏中靠左侧排列显示（在返回键后） + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + float?: 'right' | 'left'; + /** + * 按钮上文字的粗细 + * 可取值： + * "normal" - 标准字体； + * "bold" - 加粗字体。 + * 默认值为"normal"。 + * 注意：iOS平台的字体图标不支持加粗。 + * - normal: + * 标准字体 + * + * - bold: + * 加粗字体 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + fontWeight?: 'normal' | 'bold'; + /** + * 按钮上文字大小 + * 可取值：字体高度像素值，数字加"px"格式字符串，如"22px"。 + * 窗口标题栏为透明样式（type="transparent"）时，默认值为"22px"； + * 窗口标题栏为默认样式（type="default"）时，默认值为"27px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + fontSize?: string; + /** + * 按钮上文字使用的字体文件路径 + * 字体文件路径支持以下类型： + * 相对路径 - 相对于当前页面的host位置，如"a.ttf"，注意当前页面为网络地址则不支持； + * 绝对路径 - 系统绝对路径，如Android平台"/sdcard/a.ttf"，此类路径通常通过其它5+ API获取的； + * 扩展相对路径URL(RelativeURL) - 以"_"开头的相对路径，如"_www/a.ttf"； + * 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + fontSrc?: string; + /** + * 按钮点击后触发的回调函数 + * 回调函数中将返回此JSON对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + onclick?: (result: any) => void; + /** + * 按钮上是否显示红点 + * 设置为true则显示红点，false则不显示红点。默认值为false。 + * 注意：当设置了角标文本时红点不显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + redDot?: boolean; + /** + * 是否显示选择指示图标 + * 设置为true则显示选择指示图标（向下箭头），颜色与文字颜色一致； + * false则不显示。默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + select?: boolean; + /** + * 按钮上显示的文字 + * 推荐使用一个字符，超过一个字符可能无法正常显示，使用字体图标时unicode字符表示必须'\u'开头，如"\ue123"（注意不能写成"\e123"）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + text?: string; + /** + * 按钮的宽度 + * 可取值： + * "*px" - 逻辑像素值，如"10px"表示10逻辑像素值，按钮的内容居中显示； + * "auto" - 自定计算宽度，根据内容自动调整按钮宽度。 + * 默认值为"44px"（适合字体图标）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + width?: string; +} + +/** + * 窗口标题栏搜索框样式 + * 搜索输入框输入内容变化时触发"titleNViewSearchInputChanged"事件； + * 用户点击软键盘上的“搜索”按钮时触发"titleNViewSearchInputConfirmed"事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewTitleNViewSearchInputStyles { + /** + * 是否自动获取焦点 + * 设置为true表示自动获取焦点，当窗口显示时搜索编辑框自动获取输入焦点（弹出软键盘）。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + autoFocus?: boolean; + /** + * 非输入状态下文本的对齐方式 + * 可取值： + * "left" - 居左对齐； + * "right" - 居右对齐； + * "center" - 居中对齐。 + * 默认值为"center"（居中对齐）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + align?: string; + /** + * 背景颜色 + * 颜色值格式为"#RRGGBB"和"rgba(R,G,B,A)"，如"#FF0000"表示背景颜色为红色。 + * 默认值为白色半透明"rgba(255,255,255,0.5)"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backgroundColor?: string; + /** + * 输入框的圆角半径 + * 取值格式为"XXpx"，其中XX为像素值（逻辑像素），如"10px"表示10像素半径圆角。 + * 默认值为无圆角。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + borderRadius?: string; + /** + * 是否禁止输入 + * 未禁止输入时，点击编辑框可获取输入焦点（弹出软键盘）； + * 禁止输入搜索框则无法获取焦点，点击编辑框触发"titleNViewSearchInputClicked"事件。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + disabled?: boolean; + /** + * 文本颜色 + *

+ * 颜色值格式为"#RRGGBB"和"rgba(R,G,B,A)"，如"#FF0000"表示提示文本颜色为红色。 + * 默认值为"#000000"。 + * 注意：HBuilderX2.9.0+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + color?: string; + /** + * 提示文本 + * 搜索框未中输入内容为空时显示的文本内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + placeholder?: string; + /** + * 提示文本颜色 + * 颜色值格式为"#RRGGBB"和"rgba(R,G,B,A)"，如"#FF0000"表示提示文本颜色为红色。 + * 默认值为"#CCCCCC"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + placeholderColor?: string; +} + +/** + * 标题栏控件的进度条样式 + * 显示在标题栏控件底部。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewProgressStyles { + /** + * 进度条颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示绘制红色分割线； + * "rgba(R,G,B,A)"格式字符串，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255， + * A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为"#00FF00"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + color?: string; + /** + * 进度条高度 + * 可取值：像素值（逻辑像素），支持小数点，如"1px"表示1像素高；百分比，如"1%"，相对于标题栏控件的高度。 + * 默认值为"2px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + height?: string; +} + +/** + * 窗口标题栏控件的分割线样式 + * 显示在标题栏控件底部。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewSplitLineStyles { + /** + * 底部分割线颜色 + * 可取值： "#RRGGBB"格式字符串，如"#FF0000"表示绘制红色分割线； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为"#CCCCCC"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + color?: string; + /** + * 底部分割线高度 + * 格式为"Xpx"，其中X表示逻辑像素值， 默认值为"1px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + height?: string; +} + +/** + * Webview窗口事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewEvent { + /** + * Webview窗口关闭事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口关闭时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + close?: string; + /** + * Webview窗口回弹事件 + * 通过WebviewObject对象的setBounce方法开启回弹效果设置顶部下拉回弹changeoffset属性后，当用户向下拖拽窗口时触发发此事件，回调函数类型为BounceEventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + dragBounce?: string; + /** + * Webview窗口回弹事件 + * 通过WebviewObject对象的setBounce方法开启回弹效果设置左右侧侧滑slideoffset属性后，当用户向左右侧拖拽窗口侧滑时触发发此事件，回调函数类型为BounceEventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + slideBounce?: string; + /** + * Webview窗口加载错误事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口加载错误时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + error?: string; + /** + * Webview窗口隐藏事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口隐藏（窗口动画完成后）时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + hide?: string; + /** + * Webview窗口页面开始加载事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口开始加载新页面时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + loading?: string; + /** + * Webview窗口页面加载完成事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口页面加载完成时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + loaded?: string; + /** + * Webview窗口显示遮罩层时点击事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口通过mask属性设置显示遮罩层并且点击时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + maskClick?: string; + /** + * Webview内核崩溃事件 + * iOS平台使用WKWebview时，当系统内存不足时可能会导致WKWebview内核崩溃（页面白屏）。 + * 此时会触发recovery事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + recovery?: string; + /** + * Webview窗口开始渲染事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口开始渲染内容时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + rendering?: string; + /** + * Webview窗口渲染完成事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口渲染完成时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + rendered?: string; + /** + * Webview窗口显示事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口显示（窗口动画完成后）时触发此事件，回调函数类型为EventCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + show?: string; + /** + * Webview标题栏搜索框输入内容更新事件 + * 当页面配置原生标题栏显示搜索框，在搜索框获取焦点输入的内容发生变化时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleNViewSearchInputChanged?: string; + /** + * Webview标题栏搜索框输入确认事件 + * 当页面配置原生标题栏显示搜索框，在搜索框获取完成（用户点击软键盘的“搜索”按钮）时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleNViewSearchInputConfirmed?: string; + /** + * Webview标题栏搜索框点击事件 + * 当页面配置原生标题栏显示搜索框并设置disabled为true，点击搜索输入框时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleNViewSearchInputClicked?: string; + /** + * Webview标题栏搜索框焦点变化事件 + * 当页面配置原生标题栏显示搜索框，搜索框的输入焦点发生变化时触发。 + * 回调函数中的focus属性值为true表示获取焦点，false表示失去焦点。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleNViewSearchInputFocusChanged?: string; + /** + * Webview加载页面标题更新事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口加载新页面更新标题时触发此事件，回调函数类型为SuccessCallback。 + * 注意：此事件会先于loaded事件触发，通常在加载网络页面时通过此事件可更快获取到页面的标题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleUpdate?: string; + /** + * Webview窗口接收到触屏事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当用户操作按下到Webview窗口时触发此事件，回调函数类型为SuccessCallback。 + * 注意：每按下屏幕触发一次此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + touchstart?: string; + /** + * Webview窗口侧滑返回事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口侧滑返回时触发此事件，回调函数类型为PopGestureCallback。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + popGesture?: string; + /** + * Webview窗口加载进度变化事件 + * 通过WebviewObject对象的addEventListener方法添加事件监听函数，当Webview窗口加载页面进度变化时触发此事件。 + * 回调函数原型为void PorgressCandedCallback(Event e),可通过e.progress获取窗口加载进度，取值范围为0-100。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + progressChanged?: string; + /** + * Webview窗口下拉刷新事件 + * Webview窗口打开下拉刷新功能后，用户操作下拉刷新时或调用beginPullToRefresh方法时触发，用于通知业务逻辑可以开始执行刷新操作。 + * 更新操作完成后调用窗口的endPullToRefresh方法结束下拉刷新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + pullToRefresh?: string; + /** + * Webview窗口暂停事件 + * Webview窗口被暂停（调用pause方法）时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + webPause?: string; + /** + * Webview窗口恢复事件 + * Webview窗口从暂停状态恢复（调用resume方法）时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + webResume?: string; +} + +/** + * JSON对象，原生窗口扩展参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewExtraOptions { + /** + * 窗口动画加速 + * 开启窗口动画加速功能可优化窗口动画效果，提升动画流程度，可避免部分设备上打开（关闭）窗口闪屏的问题。 + * 可取值： + * "auto" - 自动优化窗口动画； + * "none" - 关闭窗口动画加速功能； + * "capture" - 使用截屏方式加速窗口动画。 + * 默认值为"auto"。 + * - auto: + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + acceleration?: 'auto'; + /** + * 窗口动画加速时使用的图片 + * 当使用截屏方式加速窗口动画时，可设置已经创建好的截屏图片，此时不会进行实时截屏操作，加速窗口动画响应时间，提升用户体验。 + * 如果未指定截屏图片，则实时截取当前Webview窗口对象的图片进行动画操作。 + * 如果窗口未使用截屏方式加速动画，则忽略此参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + capture?: PlusNativeObjBitmap; + /** + * 关联窗口动画使用的图片 + * 当使用截屏方式加速窗口动画时，可设置已经创建好的截屏图片，此时不会进行实时截屏操作，加速关联窗口动画响应时间，提升用户体验。 + * 如果未指定截屏图片，则实时截取关联Webview窗口对象的图片进行动画操作。 + * 如果窗口未使用截屏方式加速动画，则忽略此参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + otherCapture?: PlusNativeObjBitmap; +} + +/** + * 原生控件在窗口中显示的位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewPosition { + /** + * 控件在页面中正常定位，如果页面存在滚动条则随窗口内容滚动 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + static?: string; + /** + * 控件在页面中绝对定位，如果页面存在滚动条不随窗口内容滚动 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + absolute?: string; + /** + * 控件在页面中停靠，停靠的位置通过dock属性进行定义 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + dock?: string; +} + +/** + * Webview窗口下拉刷新样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewPullToRefreshStyles { + /** + * 是否开启Webview窗口的下拉刷新功能 + * true表示开启窗口的下拉刷新功能； + * false表示关闭窗口的下拉刷新功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + support?: boolean; + /** + * 下拉刷新控件颜色 + * 颜色值格式为"#RRGGBB"，如"#FF0000"为设置下拉属性控件为红色，默认值为"#2BD009"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + color?: string; + /** + * 下拉刷新样式 + * 用于定义下拉刷新风格样式，可取值： + * "default" - 经典下拉刷新样式（下拉拖动时页面内容跟随）； + * "circle" - 圆圈样式下拉刷新控件样式（下拉拖动时仅刷新控件跟随）。 + * 默认值为"default"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + style?: string; + /** + * 窗口的下拉刷新控件进入刷新状态的拉拽高度 + * 支持百分比，如"10%"；像素值，如"50px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + height?: string; + /** + * 窗口可下拉拖拽的范围 + * 支持百分比，如"10%"；像素值，如"50px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + range?: string; + /** + * 下拉刷新控件的起始位置 + * 仅对"circle"样式下拉刷新控件有效，用于定义刷新控件下拉时的起始位置。 + * 相对于Webview的顶部偏移量，支持百分比，如"10%"；像素值，如"50px"。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + offset?: string; + /** + * 在下拉可刷新状态时显示的内容 + * 支持以下属性： + * caption：在下拉可刷新状态时下拉刷新控件上显示的标题内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + contentdown?: any; + /** + * 在释放可刷新状态时显示的内容 + * 支持以下属性： + * caption：在释放可刷新状态时下拉刷新控件上显示的标题内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + contentover?: any; + /** + * 在正在刷新状态时显示的内容 + * 支持以下属性： + * caption：在正在刷新状态时下拉刷新控件上显示的标题内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + contentrefresh?: any; +} + +/** + * Webview窗口rendered事件参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewRenderedEventOptions { + /** + * 判断窗口渲染完成类型 + * 可取值： + * "top"-从顶部向下偏移22px横线截屏检测渲染是否完成； + * "bottom"-从底部向上偏移25px横线检测渲染是否完成； + * "center"-从中间横线检测渲染是否完成； + * "auto"为全屏检测（左、中、右三条竖线）。 + * 默认值为"auto"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + type?: string; + /** + * 判断窗口渲染完成间隔时间 + * 单位为ms（毫秒），默认值为150ms。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + interval?: number; +} + +/** + * 替换H5标准API配置信息 + * 目前仅支持替换H5标准定位接口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewReplaceWebApiOptions { + /** + * 替换H5标准定位接口(navigator.geolocation.*) + * 由于网络原因，在部分手机上可能无法调用标准H5定位接口(navigator.geolocation.*)获取定位数据，此时可以通过此属性配置使用原生定位模块替换标准H5定位接口，可取值： + * "alldevice" - 在所有设备上替换标准H5定位接口(navigator.geolocation.*)； + * "auto" - 自动替换H5标准定位接口，仅在调用标准H5定位接口无法获取数据的设备上替换； + * "none" - 不替换H5标准定位接口(navigator.geolocation.*)。 + * 默认值为"none"。 + * 注意：替换H5标准定位接口，会导致页面加载速度延迟100ms左右，推荐使用"auto"模式。 + * - alldevice: + * 强制替换H5标准定位接口(navigator.geolocation.*) + * + * - auto: + * 自动替换标准H5定位接口，仅在调用标准H5定位接口无法获取数据的设备上替换 + * + * - none: + * 不替换标准H5定位接口(navigator.geolocation.*) + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + geolocation?: 'alldevice' | 'auto' | 'none'; +} + +/** + * JSON对象，Webview窗口的系统状态栏区域样式 + * 仅在应用设置为沉浸式状态栏样式下有效，非沉浸式状态栏样式下忽略此属性。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewStatusbarStyles { + /** + * 系统状态栏区域背景颜色 + * 颜色值格式为"#RRGGBB"，如"#FF0000"表示为红色背景。 + * 默认值为应用manifest.json中plus->statusbar->background属性配置的值，如果未配置此属性值，则使用系统默认状态栏的背景颜色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + background?: string; +} + +/** + * JSON对象，Webview窗口对象的样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewStyles { + /** + * 窗口加载页面时额外添加的HTTP请求头数据 + * 仅在Webview窗口第一次加载页面时使用，如用户点击的触发的链接跳转则不再添加此额外请求头数据。 + * 如果Webview窗口非第一次加载页面时也需要额外添加HTTP请求头数据，可通过loadURL()方法的参数设置。 + * 如果HTTP请求头中已经包含需要额外添加的头数据，则添加的请求数据覆盖默认值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + additionalHttpHeaders?: any; + /** + * 窗口动画优化方式 + * 可取值： + * "auto" - 如果窗口中存在titleNView或subNViews，窗口动画时真实Webview控件从动画窗口中移除加速（避免真实Webview渲染影响动画效率）； + * "none" - 窗口动画不使用优化。 + * 默认值为"auto"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + animationOptimization?: string; + /** + * 窗口动画蒙层背景颜色 + *

+ * 在Android平台上，使用 pop-in/pop-out 窗口动画时，上一个页面会有半透明蒙层效果，此颜色为透明后看到的蒙层背景颜色。 + * 支持"#RRGGBB"格式字符串，如"#FF0000"表示红色，默认值为background属性设置的背景颜色，为了避免转场动画期间蒙层闪烁应该设置与background相近的颜色。 + * 注意： HBuilderX2.6.12+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + animationAlphaBGColor?: string; + /** + * 窗口的缓存模式 + * 可取值： + * "default" - 根据cache-control决定是否使用缓存数据，如果存在缓存并且没有过期则使用本地缓存资源，否则从网络获取； + * "cacheElseNetwork" - 只要存在缓存（即使过期）数据则使用，否则从网络获取； + * "noCache" - 不使用缓存数据，全部从网络获取； + * "cacheOnly" - 仅使用缓存数据，不从网络获取（注：如果没有缓存数据则会导致加载失败）。 + * 默认使用"default"。 + * - default: + * 根据cache-control决定是否使用缓存数据，如果存在缓存并且没有过期则使用本地缓存资源，否则从网络获取。 + * + * - cacheElseNetwork: + * 只要存在缓存（即使过期）数据则使用，否则从网络获取。 + * + * - noCache: + * 不使用缓存数据，全部从网络获取。 + * + * - cacheOnly: + * 仅使用缓存数据，不从网络获取（注：如果没有缓存数据则会导致加载失败）。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + cachemode?: 'default' | 'cacheElseNetwork' | 'noCache' | 'cacheOnly'; + /** + * Webview窗口自动处理返回键逻辑 + * 当Webview窗口在显示栈顶，并且Webview窗口中没有调用JS监听返回键（plus.key.addEventListener('backbutton',...)）时按下返回键响应行为。 + * 可取值： + * "hide" - 隐藏Webview窗口，隐藏动画与上一次调用显示时设置的动画类型相对应（如“slide-in-right”对应的关闭动画为“slid-out-right”）； + * "close" - 关闭Webview窗口，关闭动画与上一次调用显示时设置的动画类型相对应（如“slide-in-right”对应的关闭动画为“slid-out-right”） ； + * "none" - 不做操作，将返回键传递给下一Webview窗口处理； + * "quit" - 退出应用。 + * - hide: + * 隐藏Webview窗口，隐藏动画与上一次调用显示时设置的动画类型相对应（如“slide-in-right”对应的关闭动画为“slid-out-right”）。 + * + * - close: + * 关闭Webview窗口，关闭动画与上一次调用显示时设置的动画类型相对应（如“slide-in-right”对应的关闭动画为“slid-out-right”）。 + * + * - none: + * 不做操作，将返回键传递给下一Webview窗口处理。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backButtonAutoControl?: 'hide' | 'close' | 'none'; + /** + * 窗口的背景颜色 + * 窗口空白区域的背景模式，设置background为颜色值(参考CSS Color Names，可取值/十六进制值/rgb值/rgba值)，窗口为独占模式显示（占整个屏幕区域）； + * 设置background为“transparent”，则表示窗口背景透明，为非独占模式。 + * 对于全屏窗口可以设置此背景颜色为渲染后的页面背景色，可避免页面在渲染前闪白的现象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + background?: string; + /** + * webview的背景是否透明 + *

+ * 布尔类型，true表示透明，false表示不透明，默认值为false。 + * webview加载html页面时在性能较低的情况下DOM渲染会先显示白色，如果DOM背景色不为白色时可能会出现闪白的现象，此时可以设置webview背景为透明，同时设置background属性为DOM的背景色来避免闪白。 + * 当background属性值为“transparent”时忽略此值。 + * 注意：HBuilderX2.7.15+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + webviewBGTransparent?: boolean; + /** + * 窗口顶部背景颜色值 + * 窗口内容滚动到顶部下拉时可见。 + * 可取值： + * "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backgroundColorTop?: string; + /** + * 窗口底部背景颜色 + * 窗口内容滚动到底部上拉时可见。 + * 可取值： + * "#RRGGBB"格式字符串，如"#FF0000"表示红色； + * "rgba(R,G,B,A)"，其中R/G/B分别代表红色值/绿色值/蓝色值，正整数类型，取值范围为0-255，A为透明度，浮点数类型，取值范围为0-1（0为全透明，1为不透明），如"rgba(255,0,0,0.5)"，表示红色半透明。 + * 默认值为透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + backgroundColorBottom?: string; + /** + * 是否阻塞网络图片的加载 + * 布尔类型，true表示阻塞，false表示不阻塞，默认值为false。 + * 阻塞后Webview窗口将不加载页面中使用的所有网络图片，可通过Webview窗口对象的setBlockNetWorkImage()方法动态修改此状态。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + blockNetworkImage?: boolean; + /** + * 窗口垂直向上的偏移量 + * 支持百分比、像素值，默认值无值（根据top和height属性值来自动计算）。 + * 当同时设置了top和height值时，忽略此属性值； + * 当未设置height值时，可通过top和bottom属性值来确定窗口的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + bottom?: string; + /** + * 窗口遇到边框是否有反弹效果 + * 可取值： + * "none" - 表示没有反弹效果； + * "vertical" - 表示垂直方向有反弹效果； + * "horizontal" - 表示水平方向有反弹效果； + * "all" - 表示垂直和水平方向都有反弹效果。 + * 默认值为"none"。 + * - none: 没有反弹效果 + * - vertical: 垂直方向有反弹效果 + * - horizontal: 水平方向有反弹效果 + * - all: 垂直和水平方向都有反弹效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + bounce?: 'none' | 'vertical' | 'horizontal' | 'all'; + /** + * 窗口回弹效果区域的背景 + * 窗口回弹效果区域背景可支持颜色值或图片： + * 颜色值格式为"#RRGGBB"，如"#FFFFFF"为设置白色背景； + * 背景图为"url(%image path%)"，如"url(./icon.png)"为设置icon.png为背景图，图片采用平铺模式绘制。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + bounceBackground?: string; + /** + * 窗口内容停止滑动的减速度 + * 当Webview加载的内容超过其高度时，可以拖拽滑动内容，decelerationRate属性控制手指松开后页面滑动的速度。 + * 设置值越大手指松开后的滑动速度越快（滑动距离越长），其值域范围为0.0-1.0，默认值为0.989。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + decelerationRate?: number; + /** + * 禁止页面调用5+ API + *

+ * 可取值： + *

    + *
  • true - 禁止页面调用5+ API，也不会触发plusready事件
    • + *
  • false - 不禁止页面调用5+ API
    • + *
+ * HBuilderX2.5.6+版本支持，默认值为false。 + * 注意： 仅在窗口创建时设置此值有效，无法动态修改。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + disablePlus?: boolean; + /** + * 窗口的停靠方式 + * 当Webview窗口添加到另外一个窗口中时，停靠方式才会生效，采用停靠方式添加会导致原Webview窗口自动调整其大小避免其内容被子窗口盖住。 + * 可取值："top"，控件停靠则页面顶部；"bottom"，控件停靠在页面底部；"right"，控件停靠在页面右侧；"left"，控件停靠在页面左侧。 + * 默认值为"bottom"。 + * - top: 控件停靠则页面顶部 + * - bottom: 控件停靠在页面底部 + * - right: 控件停靠在页面右侧 + * - left: 控件停靠在页面左侧 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + dock?: 'top' | 'bottom' | 'right' | 'left'; + /** + * 窗口加载错误时跳转的页面地址 + * 当Webview窗口无法加载指定的url地址时（如本地页面不存在，或者无法访问的网络地址），此时会自动跳转到指定的错误页面地址（仅支持本地页面地址）。 + * 设置为“none”则关闭跳转到错误页面功能，此时页面显示Webview默认的错误页面内容。默认使用5+ Runtime内置的错误页面。 + * - none: 关闭加载页面错误自动跳转功能 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + errorPage?: 'none'; + /** + * 替换H5标准API + * 用于解决在部分设备上调用H5标准定位接口可能无法获取定位数据的问题。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + replacewebapi?: PlusWebviewWebviewReplaceWebApiOptions; + /** + * 窗口是否开启硬件加速 + * 布尔类型，true表示开启硬件加速，false表示不开启硬件加速，默认情况5+ Runtime会根据设备实际支持情况自动选择是否开启硬件加速，可以通过plus.webview.defaultHardwareAccelerated()方法获取默认Webview是否开启硬件加速。 + * 由于不同设备对硬件加速的支持情况存在差异，开启硬件加速能加速HTML页面的渲染，但也会消耗更多的系统资源，从而导致在部分设备上可能出现闪屏、发虚、分块渲染等问题，因此在特定设备的特定页面如果出现以上问题需要手动设置关闭硬件加速来避免。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + hardwareAccelerated?: boolean; + /** + * 窗口的高度 + * 支持百分比、像素值，默认为100%。 + * 当未设置height属性值时，优先通过top和bottom属性值来计算窗口的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + height?: string; + /** + * 窗口使用的内核 + * 可取值： + * "WKWebview" - 在iOS8.0及以上系统使用WKWebview内核，低版本下仍然使用UIWebview内核； + * "UIWebview" - 在所有版本上都使用UIWebview内核。 + * 默认值为"UIWebview"。 + * WKWebview内核的优势是： + * 1. 滚动时懒加载的图片也可以实时渲染，UIWebview在滚动停止后才能渲染； + * 2. WKWebview的video支持AirPlay。 + * 但WKWebview也有些限制和不足，目前已知的问题有： + * 1. 不支持跨域设置cookie，即plus.navigator.setCookie()API无法使用； + * 2. 本地的HTML页面中的XHR不支持跨域访问，需使用plus.net.XMLHttpRequest来替换； + * 3. 不支持使用WebSQL，需使用indexDB来替换； + * 4. 不支持js原生混淆功能，需使用前端js混淆来替换； + * 5. 内存不足时会白屏。 + * 首页的Webview的kernel在manifest中配置（plus->kernel->ios）。 + * - WKWebview: + * 使用"WKWebview"内核。 + * + * - UIWebview: + * 使用"UIWebview"内核。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + kernel?: 'WKWebview' | 'UIWebview'; + /** + * Webview内核崩溃后的恢复处理逻辑 + * 仅iOS平台非uni-app项目使用WKWebview时生效，uni-app项目可自动恢复（推荐转换为uni-app项目） + * 当前WKWebview崩溃后，Webview页面的JS上下文将丢失，也无法渲染DOM内容（白屏） + * 可配置以下值： + * "restart" - 重启应用，关闭所有页面重新打开应用首页，可通过（plus.runtime.isRecovery）来判断应用是否恢复重启; + * "reload" - 重新加载当前WKWebview（崩溃的WKWebview）页面，页面中JS上下文中所有数据丢失，在当前Webview中可通过plus.webview.isRecovery判断是否恢复重新加载，在其它Webview中可监听recovery事件来判断； + * "none" - 不做任何操作。 + * 默认为manifest.json中plus -> kernel -> recovery配置的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + kernelRecovery?: string; + /** + * 窗口水平向右的偏移量 + * 支持百分比、像素值，默认值为0px。 + * 未设置left属性值时，优先通过right和width属性值来计算窗口的left位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + left?: string; + /** + * 窗口的边距 + * 用于定位窗口的位置，支持auto，auto表示居中。若设置了left、right、top、bottom则对应的边距值失效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + margin?: string; + /** + * 窗口的遮罩 + * 用于设置Webview窗口的遮罩层样式，遮罩层会覆盖Webview中所有内容，包括子webview，并且截获webview的所有触屏事件，此时Webview窗口的点击操作会触发maskClick事件。 + * 字符串类型，可取值： + * rgba格式字符串，定义纯色遮罩层样式，如"rgba(0,0,0,0.5)"，表示黑色半透明； + * "none"，表示不使用遮罩层； + * 默认值为"none"，即无遮罩层。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + mask?: string; + /** + * 窗口的不透明度 + * 0为全透明，1为不透明，默认值为1，即不透明。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + opacity?: number; + /** + * 控制Webview注入5+ API时机 + * 可取值： + * "ahead" - 尽量提前注入，拦截页面中网络js请求实现提前注入，如果没有拦截到js请求则在页面loaded时注入； + * "normal" - 页面loaded时注入； + * "later" - 较晚在注入，在loaded事件发生后2s再注入，plusready事件同样延迟触发； + * "none" - 不注入，页面无法调用5+ API，不触发plusready事件。 + * 默认值为"normal"。 + * - ahead: 尽量提前注入，拦截页面中网络js请求实现提前注入，如果没有拦截到js请求则在页面loaded时注入； + * - normal: 页面loaded时注入 + * - later: 较晚在注入，在loaded事件发生后2s再注入，plusready事件同样延迟触发 + * - none: 不注入，页面无法调用5+ API，不触发plusready事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + plusrequire?: 'ahead' | 'normal' | 'later' | 'none'; + /** + * 窗口的进度条样式 + * 设置此属性则在Webview窗口的顶部显示进度条，可配置进度条颜色及高度。 + * 设置此属性值为undefined或null则隐藏进度条。 + * 默认不显示进度条。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + progress?: PlusWebviewWebviewProgressStyles; + /** + * 窗口的侧滑返回功能 + * 可取值： + * "none"-无侧滑返回功能； + * "close"-侧滑返回关闭Webview窗口； + * "hide"-侧滑返回隐藏webview窗口。 + * - none: 无侧滑返回功能 + * - close: 侧滑返回关闭Webview窗口 + * - hide: 侧滑返回隐藏webview窗口 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + popGesture?: 'none' | 'close' | 'hide'; + /** + * 窗口下拉刷新配置 + * 设置窗口是否开启下拉刷新功能及样式。 + * 开启下拉刷新后可通过监听窗口的"pullToRefresh"事件处理下拉刷新业务逻辑，更新操作完成后调用窗口的endPullToRefresh方法结束下拉刷新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + pullToRefresh?: PlusWebviewWebviewPullToRefreshStyles; + /** + * 窗口渲染模式 + * 支持以下属性值： + * "onscreen" - Webview窗口在屏幕区可见时渲染，不可见时不进行渲染，此时能减少内存使用量； + * "always" - Webview在任何时候都渲染，在内存较大的设备上使用，被遮挡的窗口在此中模式下显示的时候会有更流畅的效果。 + * 默认值为"onscreen"。 + * 仅Android平台支持。 + * - onscreen: Webview窗口在屏幕区可见时渲染，不可见时不进行渲染，此时能减少内存使用量 + * - always: Webview在任何时候都渲染，在内存较大的设备上使用，被遮挡的窗口在此中模式下显示的时候会有更流畅的效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + render?: 'onscreen' | 'always'; + /** + * 窗口水平向左的偏移量 + * 支持百分比、像素值，默认无值（根据left和width属性值来自动计算）。 + * 当设置了left和width值时，忽略此属性值； + * 当未设置width值时，可通过left和right属性值来确定窗口的宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + right?: string; + /** + * 窗口是否可缩放 + * 窗口设置为可缩放（scalable:true）时，用户可通过双指操作放大或缩小页面，此时html页面可通过meta节点设置“name="viewport" content="user-scalable=no"”来限制页面不可缩放。 + * 窗口设置为不可缩放（scalable:false）时，用户不可通过双指操作放大或缩小页面，即使页面中的meta节点也无法开启可缩放功能。 + * 默认值为false，即不可缩放。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + scalable?: boolean; + /** + * 窗口是否显示滚动条 + * 用于控制窗口滚动条样式，可取值： + * "all"：垂直和水平滚动条都显示； + * "vertical"：仅显示垂直滚动条； + * "horizontal"：仅显示水平滚动条； + * "none"：垂直和水平滚动条都不显示。 + * 默认值为"all"，即垂直和水平滚动条都显示。 + * 注意：显示滚动条的前提条件是窗口中的内容超过窗口显示的宽或高。 + * - all: 垂直和水平滚动条都显示 + * - vertical: 仅显示垂直滚动条 + * - horizontal: 仅显示水平滚动条 + * - none: 垂直和水平滚动条都不显示 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + scrollIndicator?: 'all' | 'vertical' | 'horizontal' | 'none'; + /** + * 点击设备的状态栏时是否滚动返回至顶部 + * true表示点击设备的状态栏可以滚动返回至顶部，false表示点击设备的状态栏不可以，默认值为true。 + * 此功能仅iOS平台支持，在iPhone上有且只有一个Webview窗口的scrollsToTop属性值为true时才生效，所以在显示和关闭Webview窗口时需动态更新所有Webview的scrollsToTop值，已确保此功能生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + scrollsToTop?: boolean; + /** + * 是否可分享窗口加载的链接地址 + * 在流应用环境（流应用/5+浏览器）中可通过分享按钮分享页面链接地址， + * 可取值： + * true - 可分享窗口加载页面链接地址； + * false - 不可分享窗口加载的页面链接地址，此时分享的是应用。 + * 默认值值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + shareable?: boolean; + /** + * 弹出系统软键盘模式 + * 可选值： + * "adjustPan" - 弹出软键盘时Webview窗口自动上移，以保证当前输入框可见； + * "adjustResize" - 自动调整Webview窗口大小（屏幕区域减去软键盘区域），同时自动滚动Webview保证输入框可见； + * "nothing" - 不做任何调整（软键盘可能覆盖输入框）。 + * - adjustPan: 弹出软键盘时Webview窗口自动上移，以保证当前输入框可见 + * - adjustResize: 自动调整Webview窗口大小（屏幕区域减去软键盘区域），同时自动滚动Webview保证输入框可见 + * - nothing: 不做任何调整（软键盘可能覆盖输入框） + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + softinputMode?: 'adjustPan' | 'adjustResize' | 'nothing'; + /** + * 软键盘上导航条的显示模式 + * 可选值："auto" - 表示系统默认值，即软键盘上显示导航条； + * "none" - 表示软键盘上不显示导航条。 + * 默认值为"auto"。 + * - auto: 软键盘上显示导航条 + * - none: 软键盘上不显示导航条 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + softinputNavBar?: 'auto' | 'none'; + /** + * 窗口状态栏样式 + * 仅在应用设置为沉浸式状态栏样式下有效，设置此属性后将自动保留系统状态栏区域不被Webview窗口占用（即Webview窗口非沉浸式样式显示）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + statusbar?: PlusWebviewWebviewStatusbarStyles; + /** + * 定义窗口的原生子View控件 + * 数组类型，可通过配置项设置原生子View控件，每个配置项对应添加一个原生子View控件。 + * 通过Webview窗口的getSubNViews()方法可获取原生子View控件对象数组。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + subNViews?: PlusWebviewWebviewSubNViewStyles []; + /** + * 定义窗口的标题栏控件样式 + * 设置此属性值则表明创建Webview窗口的标题栏控件，并可通过其属性值设置背景颜色、文本内容、文本颜色等。 + * 通过Webview窗口的getTitleNView()方法可获取标题栏控件对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + titleNView?: PlusWebviewWebviewTitleNViewStyles; + /** + * 窗口垂直向下的偏移量 + * 支持百分比、像素值，默认值为0px。 + * 未设置top属性值时，优先通过bottom和height属性值来计算窗口的top位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + top?: string; + /** + * 窗口定义窗口变换的动画效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + transition?: PlusWebviewWebviewTransition; + /** + * 窗口定义窗口变形效果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + transform?: PlusWebviewWebviewTransform; + /** + * Webview窗口的排版位置 + * 当Webview窗口添加到另外一个窗口中时，排版位置才会生效，排版位置决定子窗口在父窗口中的定位方式。 + * 可取值："static"，控件在页面中正常定位，如果页面存在滚动条则随窗口内容滚动；"absolute"，控件在页面中绝对定位，如果页面存在滚动条不随窗口内容滚动；"dock"，控件在页面中停靠，停靠的位置由dock属性值决定。 + * 默认值为"absolute"。 + * - static: 控件在页面中正常定位，如果页面存在滚动条则随窗口内容滚动 + * - absolute: 控件在页面中绝对定位，如果页面存在滚动条不随窗口内容滚动 + * - dock: 控件在页面中停靠，停靠的位置由dock属性值决定 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + position?: 'static' | 'absolute' | 'dock'; + /** + * 用户是否可选择内容 + * 可取值： + * true - 表示可选择内容，用户可通过长按来选择页面内容，如文本内容选择后可以弹出系统复制粘贴菜单； + * false - 表示不可选择内容，用户不可通过长按来选择页面内容。 + * 默认值为true。 + * 注意：在Web页面中可通过CSS的user-select对单个页面元素进行控制，前提是Webview对象的userSelect设置为true，否则CSS设置的user-select失效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + userSelect?: boolean; + /** + * 视频全屏播放时的显示方向 + * 可取值： + * "auto": 自动适配，如果当前页面竖屏显示，则视频全屏时竖屏显示；如果当前页面横屏显示，则视频全屏时横屏显示；如果当前页面自动感应，则视频全屏时自动感应横竖屏切换。 + * "portrait-primary": 竖屏正方向； + * "portrait-secondary": 竖屏反方向，屏幕正方向按顺时针旋转180°； + * "landscape-primary": 横屏正方向，屏幕正方向按顺时针旋转90°； + * "landscape-secondary": 横屏方向，屏幕正方向按顺时针旋转270°； + * "landscape": 横屏正方向或反方向，根据设备重力感应器自动调整； + * 默认值为“auto”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + videoFullscreen?: string; + /** + * 窗口的宽度 + * 支持百分比、像素值，默认为100%。未设置width属性值时，可同时设置left和right属性值改变窗口的默认宽度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + width?: string; + /** + * 窗口的堆叠顺序值 + * 拥有更高堆叠顺序的窗口总是会处于堆叠顺序较低的窗口的前面，拥有相同堆叠顺序的窗口后调用show方法则在前面。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + zindex?: number; +} + +/** + * 一组用于定义页面或控件变形的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewTransform { + /** + * 暂不支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + rotate?: string; + /** + * 暂不支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + translate?: string; + /** + * 暂不支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + scale?: string; + /** + * 暂不支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + skew?: string; + /** + * 暂不支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + matrix?: string; +} + +/** + * 一组用于定义页面或控件转换效果的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewTransition { + /** + * 产生变换效果的属性 + * 默认值为"all"，暂不支持其它值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + property?: string; + /** + * 变换持续的时间 + * 默认值为0，即无动画效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + duration?: string; + /** + * 窗口变换效果 + * 可取值： + * "linear"：匀速变化，匀速动画效果； + * "ease-in"：匀加速变化，逐渐变快的动画效果； + * "ease-out"：匀减速变化，逐渐变慢的动画效果； + * "ease-in-out"：先加速后减速变化，先变快后变慢的动画效果。 + * 默认值为"ease-in-out"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + timingfunction?: string; +} + +/** + * 拦截Webview窗口资源请求的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewOverrideResourceOptions { + /** + * 区配需要拦截请求资源的URL地址 + * 支持正则表达式，默认值为空字符串（即不拦截）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + match?: string; + /** + * 拦截重定向的资源地址 + * 仅支持本地资源地址，如"_www"、"_doc"、"_downloads"、"_documents"等开头的路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + redirect?: string; + /** + * 重定向的资源数据类型 + * RFC2045/RFC2046/RFC2047/RFC2048/RFC2049规范中定义的数据类型。 + * 如普通文本（text/plain）、PNG图像(image/png)、GIF图形(image/gif)、JPEG图形(image/jpeg)。 + * 如果未指定mime类型，则根据重定向资源路径自动区配。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + mime?: string; + /** + * 重定向的资源数据编码 + * 如未设置，则使用默认值"UTF-8"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + encoding?: string; + /** + * 设置重定向资源数据的http头数据 + * 可设置标注http头数据（如Content-type）,也可设置自定义数据。 + * 通常可通过此属性来设置拦截资源的缓存策略（如Cache-control）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + header?: any; +} + +/** + * 拦截Webview窗口URL请求的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewOverrideUrlOptions { + /** + * 拦截URL请求生效时机 + * 可取值： + * "instant" - 表示立即生效，即调用overrideUrlLoading方法后立即生效； + * "touchstart" - 表示用户操作Webview窗口（触发touchstart事件）后生效，如果用户没有操作Webview窗口则不对URL请求操作进行拦截处理。 + * 默认值为"instant"。 + * - instant: + * 立即生效，即调用overrideUrlLoading方法后立即生效。 + * + * - : + * 表示用户操作Webview窗口（触发touchstart事件）后生效。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + effect?: 'instant' | ''; + /** + * 拦截模式 + * 可取值： + * "allow"表示满足match属性定义的条件时不拦截url继续加载，不满足match属性定义的条件时拦截url跳转并触发callback回调； + * "reject"表示满足match属性定义的提交时拦截url跳转并触发callback回调，不满足match属性定义的条件时不拦截url继续加载。 + * 默认值为"reject"。 + * - allow: + * 满足match属性定义的条件时不拦截url继续加载，不满足match属性定义的条件时拦截url跳转并触发callback回调。 + * + * - reject: + * 满足match属性定义的提交时拦截url跳转并触发callback回调，不满足match属性定义的条件时不拦截url继续加载。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + mode?: 'allow' | 'reject'; + /** + * 区配是否需要处理的URL请求 + * 支持正则表达式，默认值为对所有URL地址生效（相当于正则表达式“.*”）。 + * 如果mode值为"allow"则允许区配的URL请求跳转，mode值为"reject"则拦截区配的URL请求。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + match?: string; + /** + * 排除拦截处理请求类型 + * 不拦截处理指定类型的URL请求，直接使用系统默认处理逻辑。 + * 可取值： + * "none"表示不排除任何URL请求（即拦截处理所有URL请求）； + * "redirect"表示排除拦截处理301/302跳转的请求（谨慎使用，非a标签的href触发的URL请求可能会误判断为302跳转）。 + * 默认值为"none"。 + * - none: + * 不排除任何URL请求（即拦截处理所有URL请求）。 + * + * - redirect: + * 排除拦截处理301/302跳转的请求（谨慎使用，非a标签的href触发的URL请求可能会误判断为302跳转）。 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + exclude?: 'none' | 'redirect'; +} + +/** + * 监听Webview窗口资源加载的属性 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewWebviewListenResourceOptions { + /** + * 区配是否需要处理的URL资源 + * 支持正则表达式，默认值为对所有URL资源请求生效（相当于正则表达式“.*”）。 + * 如果Webview加载的资源区配条件，则触发回调事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + match?: string; +} + +/** + * 隐藏标题栏上按钮的红点 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewHideTitleNViewButtonRedDotOptions { + /** + * 按钮的索引值 + * 此值为WebviewTitleNViewButtonStyles的buttons属性中的数组索引值来操作对应的按钮，从0开始。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + index?: number; +} + +/** + * 移除标题栏上按钮的角标 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewRemoveTitleNViewButtonBadgeOptions { + /** + * 按钮的索引值 + * 此值为WebviewTitleNViewButtonStyles的buttons属性中的数组索引值来操作对应的按钮，从0开始。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + index?: number; +} + +/** + * 临时设置弹出系统软键盘样式 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewSetSoftinputTemporaryOptions { + /** + * 软键盘模式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + mode?: string; + /** + * 触发弹出软键盘的编辑框位置信息 + * 支持设置以下属性： + * top - 编辑框距离窗口顶部的距离； + * height - 编辑框的高度。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + position?: any; +} + +/** + * 设置标题栏上按钮的角标 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewSetTitleNViewButtonBadgeOptions { + /** + * 按钮的索引值 + * 此值为WebviewTitleNViewButtonStyles的buttons属性中的数组索引值来操作对应的按钮，从0开始。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + index?: number; + /** + * 角标文本内容 + * 最多显示3个字符，超过则显示...。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + text?: string; +} + +/** + * 设置标题栏上按钮的红点 使用的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ +interface PlusWebviewShowTitleNViewButtonRedDotOptions { + /** + * 按钮的索引值 + * 此值为WebviewTitleNViewButtonStyles的buttons属性中的数组索引值来操作对应的按钮，从0开始。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/webview.html](http://www.html5plus.org/doc/zh_cn/webview.html) + */ + index?: number; +} + +/** + * XMLHttpRequest模块管理网络请求，与标准HTML中的XMLHttpRequest用途一致，差别在于前者可以进行跨域访问。通过plus.net可获取网络请求管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ +interface PlusNet { + /** + * 跨域网络请求对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + XMLHttpRequest?: typeof PlusNetXMLHttpRequest; + /** + * HTTP请求进度事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + ProgressEvent?: PlusNetProgressEvent; +} + +/** + * 跨域网络请求对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ +declare class PlusNetXMLHttpRequest { + /** + * HTTP 请求的状态 + * 当XMLHttpRequest 初次创建时，这个属性的值从 0 开始，直到接收到完整的 HTTP 响应，这个值增加到 4。 + * 5 个状态中每一个都有一个相关联的非正式的名称，下表列出了状态、名称和含义： + * 0 - Uninitialized，未初始化状态。XMLHttpRequest对象已创建或已被abort()方法重置。 + * 1 - Open，open()方法已调用，但是send()方法未调用。请求还没有被发送。 + * 2 - Sent，send()方法已调用，HTTP/HTTPS 请求已发送到服务器，但未接收到响应。 + * 3 - Receiving，所有响应头部都已经接收到，响应体开始接收但未完成。 + * 4 Loaded，HTTP响应已经完全接收。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + readyState?: number; + /** + * 请求从服务器接收到的响应数据 + * 如果没有从服务器接收到数据，则为null； + * 否则根据responseType类型决定： + * 如果responseType设置为空字符串或"text"，则返回空字符串； + * 如果responseType设置为"document"，则返回Document对象； + * 如果responseType设置为"json"，则返回JSON对象； + * 若服务器返回的数据与设置的responseType类型不区配，则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + response?: string; + /** + * 请求从服务器接收到的响应数据（字符串数据） + * 如果还没有接收到数据的话，此属性值为空字符串； + * 如果readyState小于3，此属性值为空字符串； + * 如果readyState为3，此属性值返回目前已经接收的HTTP响应部分数据值； + * 如果readyState为4，此属性值保存了完整的HTTP响应数据体。 + * 如果HTTP请求返回的数据头中包含了Content-Type值中指定字符编码，就使用该编码，否则，使用UTF-8字符集。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + responseText?: string; + /** + * 请求响应数据response的类型 + * 默认值为空字符串，即reponse为String，类型可设置："document"表示Document对象，"json"表示JSON对象，"text"表示字符串。 + * 此值必须在调用send方法之前设置，否则设置的值不生效，仍使用之前设置的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + responseType?: string; + /** + * 请求响应的Document对象 + * 对请求的响应，解析为 XML 并作为 Document 对象返回。 + * 如果请求未成功，或响应的数据无法被解析为XML，则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + responseXML?: string; + /** + * 服务器返回的状态码 + * 服务器返回的HTTP状态代码，如200表示成功，而404表示"Not Found"错误； + * 当readyState小于3的时候此属性值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + status?: number; + /** + * 服务器返回的状态描述 + * 此属性值用名称而不是数字指定了请求的HTTP的状态代码。 + * 也就是说，当状态为200的时候它是"OK"；当状态为404的时候它是"Not Found"。 + * 和status属性类似，当readyState小于3的时候此属性值为空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + statusText?: string; + /** + * 请求服务器的超时时间，单位为毫秒（ms） + * 数值类型，单位为ms，其默认值为120秒。 + * 超时时间为服务器响应请求的时间（不是Http请求完成的总时间），如果设置为0则表示永远不超时。 + * 必须在请求发起前设置，否则当前请求将不生效，在当前请求完成后重新发起新请求时生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + timeout?: number; + /** + * 是否支持跨域请求 + * 此对象创建的HTTP请求都支持跨域，所以永远返回true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + withCredentials?: boolean; + /** + * 网络请求状态发生变化事件 + * 网络请求状态发生变化时触发，通常在函数中判断对象的state属性值来获取当前请求的状态。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onreadystatechange?: () => void; + /** + * 网络请求开始事件 + * 通常在调用send方法开始发起HTTP请求时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onloadstart?: (result: PlusNetProgressEvent) => void; + /** + * 网络请求传输数据事件 + * 在HTTP请求链接已经建立，开始传输数据时触发，数据传输的过程中可能多次触发，此事件与onreadystatechange事件触发状态3类似。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onprogress?: (result: PlusNetProgressEvent) => void; + /** + * 网络请求取消事件 + * 通常在调用abort方法取消HTTP请求时触发。 + * 此事件在onreadystatechange事件触发状态4事件之后。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onabort?: (result: PlusNetProgressEvent) => void; + /** + * 网络请求错误事件 + * 通常在HTTP/HTTPS请求发生错误时触发，如无法连接到服务器等各种错误都触发此事件。 + * 此事件在onreadystatechange事件触发状态4事件之后。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onerror?: (result: PlusNetProgressEvent) => void; + /** + * 网络请求成功事件 + * 通常在HTTP/HTTPS请求成功完成时触发，如果HTTP/HTTPS请求发生错误则不触发此事件。 + * 此事件在onreadystatechange事件触发状态4事件之后。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onload?: (result: PlusNetProgressEvent) => void; + /** + * 网络请求超时事件 + * 通常在HTTP/HTTPS请求超时时触发，此时不会触发onerror事件。 + * 此事件在onreadystatechange事件触发状态4事件之后。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + ontimeout?: (result: PlusNetProgressEvent) => void; + /** + * 网络请求结束事件 + * 通常在HTTP/HTTPS请求结束时触发，不管是HTTP请求失败、成功、或超时之后都会触发此事件。 + * 此事件在onreadystatechange事件触发状态4事件之后。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + onloadend?: (result: PlusNetProgressEvent) => void; + /** + * 取消当前响应，关闭连接并且结束任何未决的网络活动 + * 此方法把XMLHttpRequest对象重置为readyState为0的状态，并且取消所有未决的网络活动。 + * 调用此方法后将停止触发XMLHttpRequest对象的所有事件。 + * 例如，如果请求用了太长时间，而且响应不再必要的时候，可以调用这个方法。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + abort(): void; + /** + * 获取HTTP响应头部信息 + * 把HTTP响应头部作为未解析的字符串返回。 如果readyState小于3，这个方法返回null。 + * 否则，它返回服务器发送的所有 HTTP 响应的头部。头部作为单个的字符串返回，一行一个头部。每行用换行符"\r\n"隔开。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + getAllResponseHeaders(): string; + /** + * 获取指定的HTTP响应头部的值 + * 其参数是要返回的 HTTP 响应头部的名称。可以使用任何大小写来制定这个头部名字，和响应头部的比较是不区分大小写的。 + * 该方法的返回值是指定的 HTTP 响应头部的值，如果没有接收到这个头部或者readyState小于3则为空字符串。 + * 如果接收到多个有指定名称的头部，这个头部的值被连接起来并返回，使用逗号和空格分隔开各个头部的值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + getResponseHeader(headerName?: string): string; + /** + * 初始化HTTP/HTTPS请求参数，但是并不发送请求 + * 初始化请求参数以供 send() 方法稍后使用。它把readyState设置为1，删除之前指定的所有请求头部，以及之前接收的所有响应头部，并且把responseText、responseXML、status 以及 statusText 参数设置为它们的默认值。 + * 当readyState为0的时候（当XMLHttpRequest对象刚创建或者abort()方法调用后）以及当readyState为4时（已经接收响应时），调用这个方法是安全的。 + * 当针对任何其他状态调用的时候，open()方法的行为是未指定的（可能出现异常现象）。 + * 除了保存供send()方法使用的请求参数，以及重置 XMLHttpRequest 对象以便复用，open()方法没有其他的行为。 + * 要特别注意，调用此方法时，不会创建到服务器的网络连接。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + open(method: 'GET' | 'POST', url: string, username?: string, password?: string): void; + /** + * 重写服务器返回的MIME类型 + * 此方法覆盖HTTP请求返回数据头"Content-Type"字段值中包含的IMIE类型，如果设置的MIME类型无效则继续使用"Content-Type"字段值中包含的IMIE类型。 + * 如果MIME类型中指定了字符集类型（charset），则需按照指定的字符集类型对接收到的数据体（respose）进行处理，否则默认为UTF-8字符集。 + * 注意：此方法需在send方法前调用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + overrideMimeType(mime: 'text/plain; charset=utf-8'): void; + /** + * 发送HTTP请求 + * 此方法触发HTTP请求发送，如果之前没有调用open()，即readyState不是1，send()抛出一个异常。否则，将发送HTTP请求，该请求由以下几部分组成： + * 之前调用open()时指定的HTTP方法、URL； + * 之前调用setRequestHeader()时指定的请求头部（如果有的话）； + * 传递给这个方法的body参数。 + * 一旦请求发送了，send()把readyState设置为2，并触发onreadystatechange事件； + * 如果服务器响应带有一个HTTP重定向，send()方法在后台线程自动遵从重定向； + * 当所有的HTTP响应头部已经接收，send()或后台线程把readyState设置为3并触发onreadystatechange事件； + * 如果响应较长，send()或后台线程可能在状态3中触发多次onreadystatechange事件； + * 最后，当响应完成，send()或后台线程把readyState设置为4，并最后一次触发onreadystatechange事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + send(body?: string): void; + /** + * 指定一个HTTP请求的Header + * Http的Header应该包含在通过后续send()调用而发起的请求中。 + * 此方法只有当readyState为1的时候才能调用，即在调用open()之后，且在调用send()之前。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + setRequestHeader(headerName: string, headerValue: string): void; + /** + * 创建一个XMLHttpRequest 对象，对象创建时不触发任何时间和网络请求，需和open，send方法配合使用。 + */ + constructor(); +} + +/** + * HTTP请求进度事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ +interface PlusNetProgressEvent { + /** + * 事件的目标对象 + * 通知HTTP请求进度事件的XMLHttpRequest对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + target?: PlusNetXMLHttpRequest; + /** + * 进度信息是否可计算 + * HTTP请求进度信息是否有效，如果HTTP请求头中包含Content-Length头信息则为true，否则为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + lengthComputable?: number; + /** + * 当前已经接收到的数据长度 + * HTTP请求接收到的数据长度，单位为字节。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + loaded?: number; + /** + * 总数据长度 + * HTTP请求返回的总数据长度，单位为字节。 + * 如果无法获取则设置为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/net.html](http://www.html5plus.org/doc/zh_cn/net.html) + */ + total?: number; +} + +/** + * Zip模块管理文件压缩和解压，通过plus.zip可获取压缩管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ +interface PlusZip { + /** + * JSON对象，配置图片压缩的参数 + * 设置quality属性则表示操作后保存图片的质量。 + * 设置width/height属性则表示对图片进行缩放操作，设置rotate属性这表示对图片进行转换操作，设置clip属性则表示对图片进行裁剪操作，可同时设置以上操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + CompressImageOptions?: PlusZipCompressImageOptions; + /** + * JSON对象，配置视频压缩的参数 + * 设置quality属性则表示压缩视频质量。需要更精确的压缩参数控制时，可指定bitrate（码率）、fps（帧率）、及resolution（相对于原视频分辨率比例）。 + * 传入quality属性值后，bitrate、fps、resolution属性值将被忽略。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + CompressVideoOptions?: PlusZipCompressVideoOptions; + /** + * JSON对象，图片裁剪区域的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + ClipImageOptions?: PlusZipClipImageOptions; + /** + * 压缩生成Zip文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + compress(src: string, zipfile: string, successCB?: () => void, errorCB?: (result: any) => void): void; + /** + * 解压缩Zip文件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + decompress(zipfile: string, target: string, successCB?: () => void, errorCB?: (result: any) => void): void; + /** + * 图片压缩转换 + * 可用于图片的质量压缩、大小缩放、方向旋转、区域裁剪、格式转换等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + compressImage(options: PlusZipCompressImageOptions, successCB?: (result: any) => void, errorCB?: (result: any) => void): void; + /** + * 视频压缩 + *

+ * 支持设置视频的压缩质量、码率、帧率、分辨率大小等，压缩后视频格式为mp4。 + * 压缩成功后的视频默认保存到应用临时目录（应用退出时清除）。 + * 注意：HBuilderX3.1.5+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + compressVideo(options: PlusZipCompressVideoOptions, successCB?: (result: any) => void, errorCB?: (result: any) => void): void; +} + +/** + * JSON对象，配置图片压缩的参数 + * 设置quality属性则表示操作后保存图片的质量。 + * 设置width/height属性则表示对图片进行缩放操作，设置rotate属性这表示对图片进行转换操作，设置clip属性则表示对图片进行裁剪操作，可同时设置以上操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ +interface PlusZipCompressImageOptions { + /** + * 压缩视频文件的路径 + * 支持以下图片路径： + * 相对路径 - 相对于当前页面的host位置，如"a.jpg"，注意当前页面为网络地址则不支持； + * 绝对路径 - 系统绝对路径，如Android平台"/storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/www/ａ.jpg"，iOS平台"/var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/www/a.png"； + * 相对路径URL(RelativeURL) - 以"_"开头的相对路径，如"_www/a.jpg"、"_doc/b.jpg"、"_documents/c.jpg"、"_downloads/d.jpg"； + * 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * - _www/: 应用资源目录 + * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + src?: string; + /** + * 压缩转换目标图片的路径 + * 支持以下图片路径： + * 绝对路径 - 系统绝对路径，如Android平台"/storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/doc/ａ.jpg"，iOS平台"/var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png"； + * 相对路径URL(RelativeURL) - 以"_"开头的相对路径，如"_doc/b.jpg"、"_documents/c.jpg"、"_downloads/d.jpg"，注意不支持"_www"开头的路径； + * 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * 注意：如果设置的路径无权限访问，则返回失败。 + * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + dst?: string; + /** + * 覆盖生成新文件 + * 仅在dst制定的路径文件存在时有效： + * true表示覆盖存在的文件； + * false表示不覆盖，如果文件存在，则返回失败。 + * 默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + overwrite?: boolean; + /** + * 压缩转换后的图片格式 + * 支持"jpg"、"png"，默认值为jpg。 + * - jpg: JPG格式图片 + * - png: PNG格式图片 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + format?: 'jpg' | 'png'; + /** + * 压缩图片的质量 + *

+ * 取值范围为1-100，1表示使用最低的图片质量（转换后的图片文件最小）、100表示使用最高的图片质量（转换后的图片文件最大）； + * 默认值为50。 + * 注意：仅对jpg格式图片有效。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + quality?: number; + /** + * 缩放图片的宽度 + * 支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即根据height与源图高的缩放比例计算，若未设置height则使用源图高度）； + * 默认值为"auto"。 + * 注意：若设置了width属性值不合法（如"0px"），则不对图片进行缩放操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + width?: string; + /** + * 缩放图片的高度 + * 支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即根据width与源图宽的缩放比例计算，若未设置width则使用源图高度）； + * 默认值为"auto"。 + * 注意：若设置了height属性值不合法（如"0px"），则不对图片进行缩放操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + height?: string; + /** + * 旋转图片的角度 + * 支持值：90-表示旋转90度；180-表示旋转180度；270-表示旋转270度。 + * 注意：若设置rotate属性值不合法，则不对图片进行旋转操作。 + * - 90: 旋转90度 + * - 180: 旋转180度 + * - 270: 旋转270度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + rotate?: 90 | 180 | 270; + /** + * 裁剪图片的区域 + * 值参考ClipImageOptions定义，若设置clip属性值不合法，则不对图片进行裁剪操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + clip?: PlusZipClipImageOptions; +} + +/** + * JSON对象，配置视频压缩的参数 + * 设置quality属性则表示压缩视频质量。需要更精确的压缩参数控制时，可指定bitrate（码率）、fps（帧率）、及resolution（相对于原视频分辨率比例）。 + * 传入quality属性值后，bitrate、fps、resolution属性值将被忽略。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ +interface PlusZipCompressVideoOptions { + /** + * 压缩视频文件的路径 + * 支持以下路径： + * 相对路径 - 相对于当前页面的host位置，如"a.jpg"，注意当前页面为网络地址则不支持； + * 绝对路径 - 系统绝对路径，如Android平台"/storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/www/ａ.mp4"，iOS平台"/var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/www/a.mp4"； + * 相对路径URL(RelativeURL) - 以"_"开头的相对路径，如"_www/a.mp4"、"_doc/b.mp4"、"_documents/c.mp4"、"_downloads/d.mp4"； + * 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * - _www/: 应用资源目录 + * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + src?: string; + /** + * 压缩后视频文件保存的路径 + *

+ * 保存文件路径仅支持以"_downloads/"、"_doc/"、"_documents/"开头的字符串。 + * 文件路径以文件后缀名结尾（如"_doc/download/video.mp4"）表明指定保存文件目录及名称，以“/”结尾则认为指定保存文件的目录（此时程序自动生成文件名）。 + * 如果指定的文件已经存在，则自动在文件名后面加"(i)"，其中i为数字，如果文件名称后面已经是此格式，则数字i递增，如"video(1).mp4"。 + * 默认保存到应用临时目录（应用退出时清除），并自动生成文件名称。 + * 注意： HBuilderX3.1.10+版本支持。 + *

+ * - _doc/: 应用私有文档目录 + * - _documents/: 共享文档目录 + * - _downloads/: 共享下载目录 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + filename?: string; + /** + * 压缩质量 + *

+ * 可取值： + *

    + *
  • low - 低视频质量压缩，文件小、视频不够清晰
    • + *
  • medium - 中等视频质量压缩，平衡文件大小Hello uni-app视频清晰度
    • + *
  • high - 高视频质量压缩，文件大、视频较清晰
    • + *
+ * 默认值为high。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + quality?: string; + /** + * 码率 + *

+ * 单位为kbps。 + * 注意：Android暂不支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + bitrate?: number; + /** + * 帧率 + *

+ * 注意：Android暂不支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + fps?: number; + /** + * 视频分辨率 + *

+ * 相对于原视频的分辨率比例，取值范围大于0、小于等于1。 默认值为1。 + * 注意：Android暂不支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + resolution?: number; +} + +/** + * JSON对象，图片裁剪区域的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ +interface PlusZipClipImageOptions { + /** + * 图片裁剪区域与原图片上边界的偏移距离 + * 支持像素值（如"10px"）、百分比（如"10%"）；默认值为"0px"。 + * 注意：如果top值超出原图片高度，则图片裁剪失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + top?: string; + /** + * 图片裁剪区域与原图片左边界的偏移距离 + * 支持像素值（如"10px"）、百分比（如"10%"）；默认值为"0px"。 + * 注意：如果left值超出原图片宽度，则图片裁剪失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + left?: string; + /** + * 图片裁剪区域的宽度 + * 支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即从left位置到图片右边界的宽度）；默认值为"auto"。 + * 注意：如果left值加width值超出原图片宽度，则使用"auto"值进行裁剪。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + width?: string; + /** + * 图片裁剪区域的高度 + * 支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即从top位置到图片下边界的高度）；默认值为"auto"。 + * 注意：如果top值加height值超出原图片高度，则使用"auto"值进行裁剪。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/zip.html](http://www.html5plus.org/doc/zh_cn/zip.html) + */ + height?: string; +} + +/** + * Barcode模块管理条码（一维码和二维码）扫描识别，支持常见的一维码（如EAN13码）及二维码（如QR码）。通过调用设备的摄像头对条码进行扫描识别，扫描到条码后进行解码并返回码数据内容及码类型。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ +interface PlusBarcode { + /** + * 扫码识别控件对象 + * 可通过plus.barcode.create创建，也可通过new plus.barcode.Barcode构造（仅在5+APP中使用）创建。 + * 扫码识别控件将使用设备的摄像头预览扫描内容，在控件中显示扫描基准框等用户交互元素。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + Barcode?: typeof PlusBarcodeBarcode; + /** + * Barcode扫码控件样式 + * 设置Barcode扫码控件的样式，如扫码框、扫码条的颜色等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + BarcodeStyles?: PlusBarcodeBarcodeStyles; + /** + * 条码识别控件扫描参数 + * 设置Barcode扫码控件的扫码识别参数，如是否保存扫码功时的截图等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + BarcodeOptions?: PlusBarcodeBarcodeOptions; + /** + * QR二维码，数值为0 + * 1994年由日本Denso-Wave公司发明，QR来自英文Quick Response的缩写，即快速反应的意思，源自发明者希望QR码可让其内容快速被解码。 + * 目前使用最广泛的二维码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + QR?: number; + /** + * EAN条形码标准版，数值为1 + * 国际物品编码协会在全球推广应用的商品条码，是由13位数字组成。 + * 目前使用最广泛的一维条形码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + EAN13?: number; + /** + * ENA条形码简版，数值为2 + * 国际物品编码协会在全球推广应用的商品条码，是由8位数字组成。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + EAN8?: number; + /** + * Aztec二维码，数值为3 + * Andrew Longacre发明于1995年，该代码是用于国际出版。最小的Aztec码符号编码13个数字或12个英文字母。最大的Aztec码符号编码3832数字或3067英文字母或1914字节的数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + AZTEC?: number; + /** + * Data Matrix二维码，数值为4 + * Data Matrix原名Data code，由美国国际资料公司(International Data Matrix, 简称IDMatrix)于1989年发明。可编码字元集包括全部的ASCII字元及扩充ASCII字元，容量可包含2235个英文数字资料、1556个8位元资料，3116个数字资料。由于Data Matrix二维条码只需要读取资料的20%即可精确辨读，因此很适合应用在条码容易受损的场所。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + DATAMATRIX?: number; + /** + * UPC条形码标准版，数值为5 + * UPC码是美国统一代码委员会制定的一种商品用条码，主要用于美国和加拿大地区，常在美国进口的商品上可以看到。UPC码标准版由12位数字构成，故其字码集为数字0~9。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + UPCA?: number; + /** + * UPC条形码缩短版，数值为6 + * UPC码是美国统一代码委员会制定的一种商品用条码，主要用于美国和加拿大地区，常在美国进口的商品上可以看到。UPC码缩短版由8位数字构成，故其字码集为数字0~9。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + UPCE?: number; + /** + * Codabar条形码，数值为7 + * Codabar码最初是为零售价格标签系统而研制开发的。1975年，National Retail Merchants Association（NRMA）选择了其它符号类型作为标准后，Codabar开始在多个方面用于非零售应用领域，如图书馆、货运和医药业。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + CODABAR?: number; + /** + * Code39条形码，数值为8 + * Code 39码是Intermec公司于1975年推出的一维条码， 39码是一种可供使用者双向扫瞄的分散式条码，也就是说相临两资料码之间，39码必须包含一个不具任何意义的空白(或细白，其逻辑值为0)，且 39码具有支援文数字的能力，编码规则简单、误码率低、所能表示字符个数多等特点，39码在各个领域有着极为广泛的应用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + CODE39?: number; + /** + * Code93条形码，数值为9 + * Code 93码的条码符号是由Intermec公司于1982年设计的 提供更高的密度和数据安全增强code39 。它是一个字母，长度可变符号。代码93主要用于由加拿大邮政编码补充提供的资料。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + CODE93?: number; + /** + * Code128条形码，数值为10 + * CODE128码是1981年引入的一种高密度条码，CODE128 码可表示从 ASCII 0 到ASCII 127 共128个字符，故称128码。CODE128码是广泛应用在企业内部管理、生产流程、物流控制系统方面的条码码制，由于其优良的特性在管理信息系统的设计中被广泛使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + CODE128?: number; + /** + * ITF条形码，数值为11 + * ITF条码，又称交叉二五条码，由14位数字字符代表组成。主要用于运输包装，是印刷条件较差，不允许印刷EAN-13和UPC-A条码时应选用的一种条码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + ITF?: number; + /** + * MaxiCode二维码，数值为12 + * 1996年时，美国自动辨识协会（AIMUSA）制定统一的符号规格，称为Maxicode二维条码，也有人称USS-Maxicode二维条码（Uniform Symbology Specification-Maxicode）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + MAXICODE?: number; + /** + * PDF 417二维条码，数值为13 + * PDF417条码是由美国SYMBOL公司发明的，PDF（Portable Data File）意思是“便携数据文件”。组成条码的每一个条码字符由4个条和4个空共17个模块构成，故称为PDF417条码。PDF417条码最大的优势在于其庞大的数据容量和极强的纠错能力。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + PDF417?: number; + /** + * RSS 14条形组合码，数值为14 + * RSS条码是有国际物品编码协会EAN和美国统一代码委员会UCC开发的RSS（Reduced Space Symbology）条码符号。它是一种一维码和二维码的组合码。和其它线性条码相比，RSS系列码制具有更高的密度，因为它可以表示更多的字符。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + RSS14?: number; + /** + * 扩展式RSS条形组合码，数值为15 + * RSS条码是有国际物品编码协会EAN和美国统一代码委员会UCC开发的RSS（Reduced Space Symbology）条码符号。它是一种一维码和二维码的组合码。和其它线性条码相比，RSS系列码制具有更高的密度，因为它可以表示更多的字符。扩展式RSS码是长度可以变化的线性码制，能够对74个数字字符或41个字母字符的AI单元数据传数据进行编码。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + RSSEXPANDED?: number; + /** + * 扫码识别图片中的条码 + * 输入图片文件进行扫码识别，成功扫描到条码（一维码或二维码）后通过successCallback回调返回，失败则通过errorCallback回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + scan(path: string, successCB: (result0: number, result1: string, result2: string, result3: string) => void, errorCB?: (result: any) => void, filters?: 'plus.barcode.QR' | 'plus.barcode.EAN13' | 'plus.barcode.EAN8' | 'plus.barcode.AZTEC' | 'plus.barcode.DATAMATRIX' | 'plus.barcode.UPCA' | 'plus.barcode.UPCE' | 'plus.barcode.CODABAR' | 'plus.barcode.CODE39' | 'plus.barcode.CODE93' | 'plus.barcode.CODE128' | 'plus.barcode.ITF' | 'plus.barcode.MAXICODE' | 'plus.barcode.PDF417' | 'plus.barcode.RSS14' | 'plus.barcode.RSSEXPANDED', autoDecodeCharset?: boolean): void; + /** + * 创建扫码识别控件对象 + * 此方法创建扫码识别控件并不会显示在页面中，需要调用plus.webview.Webview窗口对象的append方法将其添加到Webview窗口中才能显示。 + * 注意：需要设置styles参数的top/left/width/height属性指定扫码识别控件的位置及大小，否则可能无法正确显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + create(id: string, filters?: 'plus.barcode.QR' | 'plus.barcode.EAN13' | 'plus.barcode.EAN8' | 'plus.barcode.AZTEC' | 'plus.barcode.DATAMATRIX' | 'plus.barcode.UPCA' | 'plus.barcode.UPCE' | 'plus.barcode.CODABAR' | 'plus.barcode.CODE39' | 'plus.barcode.CODE93' | 'plus.barcode.CODE128' | 'plus.barcode.ITF' | 'plus.barcode.MAXICODE' | 'plus.barcode.PDF417' | 'plus.barcode.RSS14' | 'plus.barcode.RSSEXPANDED', styles?: PlusBarcodeBarcodeStyles, autoDecodeCharset?: boolean): PlusBarcodeBarcode; + /** + * 查找扫码识别控件对象 + * 根据指定的id（标识）查找扫码控件对象，可跨页面进行查找。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + getBarcodeById(id: string): PlusBarcodeBarcode; +} + +/** + * 扫码识别控件对象 + * 可通过plus.barcode.create创建，也可通过new plus.barcode.Barcode构造（仅在5+APP中使用）创建。 + * 扫码识别控件将使用设备的摄像头预览扫描内容，在控件中显示扫描基准框等用户交互元素。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ +declare class PlusBarcodeBarcode { + /** + * 扫码识别成功事件 + * 扫码识别控件成功识别到条码（二维码）数据时触发的事件，并返回扫码结果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + onmarked?: (result0: number, result1: string, result2: string, result3: string) => void; + /** + * 扫码识别错误事件 + * 扫码识别控件在扫码过程中发生错误时触发的事件，并返回错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + onerror?: (result: any) => void; + /** + * 取消扫码识别 + * 结束对摄像头获取图片数据进行条码识别操作，同时关闭摄像头的视频捕获。 + * 结束后可调用start方法重新开始识别。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + cancel(): void; + /** + * 关闭条码识别控件 + * 释放控件占用系统资源，调用close方法后控件对象将不可使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + close(): void; + /** + * 操作闪光灯 + * 设置扫码识别控件在扫码时是否开启摄像头的闪光灯，默认值为不开启闪光灯。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + setFlash(open: boolean): void; + /** + * 设置扫码识别控件的样式 + * 用于动态更新扫码识别控件的显示样式参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + setStyle(styles: PlusBarcodeBarcodeStyles): void; + /** + * 开始扫码识别 + * 调用设备的摄像头在控件中预览，并获取捕获数据进行扫码识别，当识别出条码（二维码）数据时触发onmarked事件返回扫码结果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + start(optons?: PlusBarcodeBarcodeOptions): void; + /** + * 构造扫码识别控件 + * 创建扫码识别控件，并绑定当前Webview窗口指定id的DOM标签（如div或object等），覆盖在DOM元素上方并显示。 + * 此时styles参数中的left/top/width/height属性值将被忽略，通过DOM标签来确定扫码识别控件的位置及大小。 + * 注意：uni-app项目不能通过此方法创建扫码识别控件，应该使用plus.barcode.create方法创建。 + */ + constructor(domId: string, filters?: 'plus.barcode.QR' | 'plus.barcode.EAN13' | 'plus.barcode.EAN8' | 'plus.barcode.AZTEC' | 'plus.barcode.DATAMATRIX' | 'plus.barcode.UPCA' | 'plus.barcode.UPCE' | 'plus.barcode.CODABAR' | 'plus.barcode.CODE39' | 'plus.barcode.CODE93' | 'plus.barcode.CODE128' | 'plus.barcode.ITF' | 'plus.barcode.MAXICODE' | 'plus.barcode.PDF417' | 'plus.barcode.RSS14' | 'plus.barcode.RSSEXPANDED', styles?: PlusBarcodeBarcodeStyles, autoDecodeCharset?: boolean); +} + +/** + * Barcode扫码控件样式 + * 设置Barcode扫码控件的样式，如扫码框、扫码条的颜色等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ +interface PlusBarcodeBarcodeStyles { + /** + * 条码识别控件背景颜色 + * 颜色值支持(参考CSS颜色规范)：颜色名称(参考CSS Color Names)/十六进制值/rgb值，默认值为红色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + background?: string; + /** + * 扫码框颜色 + * 颜色值支持(参考CSS颜色规范)：颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值，默认值为红色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + frameColor?: string; + /** + * 扫码条颜色 + * 颜色值支持(参考CSS颜色规范)：颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值，默认值为红色。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + scanbarColor?: string; + /** + * Barcode扫码控件左上角的垂直偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度； + * 自动计算，如"auto",根据height值自动计算，相对于父Webview窗口垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + top?: string; + /** + * Barcode扫码控件左上角的水平偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度； + * 自动计算，如"auto"，根据width值自动计算，相对于父Webview窗口水平居中。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + left?: string; + /** + * Barcode扫码控件的宽度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + width?: string; + /** + * Barcode扫码控件的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + height?: string; + /** + * Barcode扫码控件在Webview窗口的布局模式 + * 可取值： + * "static" - 静态布局模式，如果页面存在滚动条则随窗口内容滚动； + * "absolute" - 绝对布局模式，如果页面存在滚动条不随窗口内容滚动； + * 默认值为"static"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + position?: string; +} + +/** + * 条码识别控件扫描参数 + * 设置Barcode扫码控件的扫码识别参数，如是否保存扫码功时的截图等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ +interface PlusBarcodeBarcodeOptions { + /** + * 是否保存扫码成功时的截图 + * 如果设置为true则在扫码成功时将图片保存，并通过onmarked回调函数的file参数返回保存文件的路径。 + * 默认值为false，不保存截图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + conserve?: boolean; + /** + * 保存扫码成功时图片保存路径 + * 可通过此参数设置保存截图的路径和名称，如果设置图片文件名称则必须指定文件的后缀名（必须是.png），否则认为是指定目录，文件名称则自动生成。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + filename?: string; + /** + * 扫码成功时是否需要震动提醒 + * 如果设置为true则在扫码成功时震动设备，false则不震动。 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + vibrate?: boolean; + /** + * 扫码成功时播放的提示音 + * 可取值： + * "none" - 不播放提示音； + * "default" - 播放默认提示音（5+引擎内置）。 + * 默认值为"default"。 + * - none: 扫码成功时不播放提示音 + * - default: 扫码成功时播放默认提示音 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/barcode.html](http://www.html5plus.org/doc/zh_cn/barcode.html) + */ + sound?: 'none' | 'default'; +} + +/** + * Maps模块管理地图控件，用于在web页面中显示地图控件，提供各种接口操作地图控件，如添加标点、路线等。通过plus.maps可获取地图管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMaps { + /** + * 地图控件对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Map?: typeof PlusMapsMap; + /** + * 地图控件对象的参数 + * 设置地图对象显示时使用的参数，如地图的中心位置、缩放级别等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + MapStyles?: PlusMapsMapStyles; + /** + * 地理编码转换的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + GeocodeOptions?: PlusMapsGeocodeOptions; + /** + * 地图坐标转换的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + CoordinateConvertOptions?: PlusMapsCoordinateConvertOptions; + /** + * Point对象用于表示地图元素的坐标 + * 常用语对地图上元素进行定位时使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Point?: typeof PlusMapsPoint; + /** + * 地理区域 + * 有西南及东北坐标点数据组成的矩形区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Bounds?: typeof PlusMapsBounds; + /** + * 地图视图类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + MapType?: PlusMapsMapType; + /** + * 地图覆盖物基类对象 + * Overlay是地图上显示元素的基类，用于抽象地图元素，不用于实例化。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Overlay?: PlusMapsOverlay; + /** + * 地图上显示的标点对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Marker?: typeof PlusMapsMarker; + /** + * 地图上显示的气泡对象 + * 此对象不能直接添加到地图上显示，只可关联到地图标点覆盖物上，用户点击标点时弹出显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Bubble?: typeof PlusMapsBubble; + /** + * 地图上显示的圆圈对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Circle?: typeof PlusMapsCircle; + /** + * 地图上显示的折线对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Polyline?: typeof PlusMapsPolyline; + /** + * 地图上显示的多边形对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Polygon?: typeof PlusMapsPolygon; + /** + * 地图检索对象 + * Search对象用于管理地图上的检索功能，包括位置检索、周边检索和范围检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Search?: typeof PlusMapsSearch; + /** + * 检索策略类型 + * 在线路检索时设置检索策略时使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + SearchPolicy?: PlusMapsSearchPolicy; + /** + * 保存位置检索、周边检索和范围检索返回的结果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + SearchPoiResult?: PlusMapsSearchPoiResult; + /** + * 保存位置检索、周边检索和范围检索返回的结果 + * 不可通过new操作符创建SearchRouteResult对象，在触发onRouteSearchComplete()时自动创建。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + SearchRouteResult?: PlusMapsSearchRouteResult; + /** + * 检索结果的位置点 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Position?: typeof PlusMapsPosition; + /** + * 地图中的路线对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + Route?: typeof PlusMapsRoute; + /** + * 调用系统第三方程序进行导航 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + openSysMap(dst: PlusMapsPoint, des: string, src: PlusMapsPoint): void; + /** + * 创建Map对象 + * 调用此方法创建后并不会显示，需要调用Webview窗口的append方法将其添加到Webview窗口后才能显示。 + * 注意：此时需要通过styles参数的top/left/width/height属性设置控件的位置及大小。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + create(id: string, styles?: PlusMapsMapStyles): PlusMapsMap; + /** + * 查找已经创建的Map对象 + * 调用此方法查找指定id的Map对象，如果不存在则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getMapById(id: string): PlusMapsMap; +} + +/** + * 地图控件对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsMap { + /** + * 用户点击地图事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onclick?: (result: PlusMapsPoint) => void; + /** + * 地图状态改变事件 + * 用户拖动、缩放地图等操作完成后触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onstatuschanged?: (result: any) => void; + /** + * 静态方法，计算面积 + * 计算指定地理区域的面积，单位为平方米。 + * 注：此功能仅百度地图支持，高德地图暂不支持此功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + calculateArea(bounds: PlusMapsBounds, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 静态方法，计算距离 + * 计算从pointStart坐标点到pointEnd坐标的实际直线距离，单位为米（m）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + calculateDistance(pointStart: PlusMapsPoint, pointEnd?: PlusMapsPoint, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 静态方法，坐标转换 + * 将第三方坐标系坐标转换成当前地图的坐标系坐标。 + * 转换成功通过successCallback返回，转换失败则通过errorCallback返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + convertCoordinates(point: PlusMapsPoint, options?: PlusMapsCoordinateConvertOptions, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 静态方法，地理编码 + * 将地理位置信息转换为坐标点。 + * 转换成功通过successCallback返回，转换失败则通过errorCallback返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + geocode(address: string, options?: PlusMapsGeocodeOptions, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 静态方法，反向地理编码 + * 将坐标点转换为地理位置信息。 + * 转换成功通过successCallback返回，转换失败则通过errorCallback返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + reverseGeocode(point: PlusMapsPoint, options?: PlusMapsGeocodeOptions, successCallback?: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 向地图中添加覆盖物 + * 此方法用于向地图中添加覆盖物。 + * 支持各种从maps.Overlay对象继承的各种覆盖物对象； + * 如果添加不支持的对象则直接返回false； + * 同一覆盖物对象只能添加到地图中一次，已在地图中的覆盖物再次添加时则返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + addOverlay(overlay: PlusMapsOverlay): boolean; + /** + * 设置地图初始中心点和缩放级别 + * 用于设置地图的初始中心点和缩放级别，通常在创建地图后立即调用。 + * 默认中心点为天安门，默认缩放级别为12； + * 该方法设置的中心点和缩放级别可通过reset()方法恢复； + * 如果在地图显示后调用将改变地图的中心点和缩放级别并立即更新，并将初始值更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + centerAndZoom(center: PlusMapsPoint, zoom: number): void; + /** + * 清除地图中所有覆盖物对象 + * 此方法用于清除地图中所有覆盖物对象。 + * 清除地图中的覆盖物对象后会自动更新地图视图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + clearOverlays(): void; + /** + * 关闭地图控件 + * 关闭地图控件将会销毁地图使用的资源，不可再使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + close(): void; + /** + * 获取当前地图可视范围的地理区域 + * 当旋转或俯视时，是当前地图可视范围的最大外接矩形地理区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getBounds(): PlusMapsBounds; + /** + * 获取地图中心点位置 + * 此方法用于获取设置的地图中心点位置（centerAndZoom/setCenter）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getCenter(): PlusMapsPoint; + /** + * 获取当前地图显示的地图中心点位置 + * 此方法用于获取当前地图显示的地图中心点位置，获取成功后通过callback回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getCurrentCenter(callback: (result0: number, result1: PlusMapsPoint) => void): boolean; + /** + * 获取地图的显示类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getMapType(): PlusMapsMapType; + /** + * 获取用户的当前位置信息 + * 此方法用于获取用户的当前位置信息，获取成功后通过callback回调返回。 + * 获取用户当前位置信息将打开定位设备。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getUserLocation(callback: (result0: number, result1: PlusMapsPoint) => void): boolean; + /** + * 获取地图的缩放级别 + * 当前地图显示的真实缩放级别。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getZoom(): number; + /** + * 隐藏地图控件 + * 此方法用于隐藏地图控件，通常在显示后调用此方法来隐藏。 + * 如果地图已经隐藏再调用此方法将无效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + hide(): void; + /** + * 获取是否显示用户位置 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + isShowUserLocation(): boolean; + /** + * 获取是否显示地图内置缩放控件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + isShowZoomControls(): boolean; + /** + * 获取是否打开地图交通信息图层 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + isTraffic(): boolean; + /** + * 从地图中删除覆盖物对象 + * 此方法用于从地图中删除覆盖物对象。 + * 支持各种从maps.Overlay对象继承的各种覆盖物对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + removeOverlay(overlay: PlusMapsOverlay): void; + /** + * 重置地图 + * 此方法用于重新设置地图，恢复地图的初始化时的中心点和缩放级别。 + * 该方法将导致显示内容将立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + reset(): void; + /** + * 重设地图控件大小 + * 此方法用于重新计算地图控件大小，保持与构造时传入DOM元素的大小及位置一致。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + resize(): void; + /** + * 设置地图的中心点 + * 此方法用于设置地图的中心点，用于切换当前显示地图位置。 + * 该方法改变中心点后地图显示内容将立即更新； + * 该方法不会改变地图显示的缩放级别。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setCenter(center: PlusMapsPoint): void; + /** + * 设置地图的视图类型 + * 此方法用于设置地图类型，默认为普通街道视图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setMapType(type: PlusMapsMapType): void; + /** + * 设置地图控件的配置参数 + * 用于动态更新地图控件的参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStyles(styles: PlusMapsMapStyles): void; + /** + * 是否打开地图交通信息图层 + * 此方法用于设置是否打开地图交通信息图层，默认不显示。 + * 该方法改变是否显示交通图层后地图显示内容将立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setTraffic(traffic: boolean): void; + /** + * 设置地图的缩放级别 + * 此方法用于设置地图的缩放级别，用于切换当前显示地图缩放级别。 + * 该方法改变缩放级别后地图显示内容将立即更新； + * 该方法不会改变地图显示区域，以当前地图显示的中心点位置来缩放地图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setZoom(zoom: number): void; + /** + * 显示地图控件 + * 此方法用于显示地图控件，通常在隐藏后调用此方法来显示。 + * 如果地图已经显示再调用此方法将无效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + show(): void; + /** + * 显示用户位置 + * 此方法将在地图上显示用户位置信息。 + * 显示用户位置将打开定位设备。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + showUserLocation(display: boolean): void; + /** + * 设置是否显示地图内置缩放控件 + * 此方法将在地图上显示内置缩放控件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + showZoomControls(display: boolean): void; + /** + * 创建Map对象 + * 创建Map地图控件对象，并指定其在Webview窗口中关联div或object标签的id号。 + * 此时styles参数中的left/top/width/height属性值被忽略，通过DOM标签来确定Map对象的位置及大小。 + */ + constructor(domId: string, styles?: PlusMapsMapStyles); +} + +/** + * 地图控件对象的参数 + * 设置地图对象显示时使用的参数，如地图的中心位置、缩放级别等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsMapStyles { + /** + * 地图的中心位置 + * 未设置则使用地图的默认中心点（由地图供应商确定）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + center?: PlusMapsPoint; + /** + * 地图的缩放级别 + * 有效范围为有效范围为3-21（高德地图为3-20，百度地图为4-21），默认值为12，设置无效的值则使用默认值。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + zoom?: number; + /** + * 地图的视图类型 + * 可设置普通街道视图、卫星视图，默认值为普通街道视图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + type?: PlusMapsMapType; + /** + * 地图的是否显示交通信息 + * true表示显示地图的交通信息图层，false则不显示，默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + traffic?: boolean; + /** + * 是否显示地图的内置缩放控件 + * true表示显示地图的内置缩放控件，false则不显示，默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + zoomControls?: boolean; + /** + * 地图控件左上角的垂直偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度； + * 自动计算，如"auto",根据height值自动计算，相对于父Webview窗口垂直居中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + top?: string; + /** + * 地图控件左上角的水平偏移量 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度； + * 自动计算，如"auto"，根据width值自动计算，相对于父Webview窗口水平居中。 + * 默认值为"0px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + left?: string; + /** + * 地图控件的宽度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的宽度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + width?: string; + /** + * 地图控件的高度 + * 可取值： + * 像素值，如"100px"； + * 百分比，如"10%"，相对于父Webview窗口的高度。 + * 默认值为"100%"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + height?: string; + /** + * 地图控件在Webview窗口的布局模式 + * 可取值： + * "static" - 静态布局模式，如果页面存在滚动条则随窗口内容滚动； + * "absolute" - 绝对布局模式，如果页面存在滚动条不随窗口内容滚动； + * 默认值为"static"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + position?: string; +} + +/** + * 地理编码转换的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsGeocodeOptions { + /** + * 源数据的坐标系类型 + * 仅在反向地理编码转换时生效。 + * “wgs84”：表示WGS-84坐标系； “gcj02”：表示国测局经纬度坐标系； “bd09”：表示百度墨卡托坐标系； “bd09ll”：表示百度经纬度坐标系； + * 默认使用wgs84坐标系。 + * - wgs84: WGS-84坐标系，即GPS设备采集的原始GPS坐标 + * - gcj02: 国测局经纬度坐标系，soso地图、aliyun地图、mapabc地图和amap地图所用的坐标系 + * - bd09: 百度墨卡托坐标系 + * - bd09ll: 百度经纬度坐标系 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + coordType?: 'wgs84' | 'gcj02' | 'bd09' | 'bd09ll'; + /** + * 源地址所属的城市 + * 仅在地理编码转换时生效，如果不指定则在全国范围内区配转换。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + city?: string; +} + +/** + * 地图坐标转换的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsCoordinateConvertOptions { + /** + * 源数据的坐标系类型 + * “wgs84”：表示WGS-84坐标系； “gcj02”：表示国测局经纬度坐标系； “bd09”：表示百度墨卡托坐标系； “bd09ll”：表示百度经纬度坐标系； + * 默认使用wgs84坐标系。 + * - wgs84: WGS-84坐标系，即GPS设备采集的原始GPS坐标 + * - gcj02: 国测局经纬度坐标系，soso地图、aliyun地图、mapabc地图和amap地图所用的坐标系 + * - bd09: 百度墨卡托坐标系 + * - bd09ll: 百度经纬度坐标系 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + coordType?: 'wgs84' | 'gcj02' | 'bd09' | 'bd09ll'; +} + +/** + * Point对象用于表示地图元素的坐标 + * 常用语对地图上元素进行定位时使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsPoint { + /** + * 设置坐标点的经度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLng(lng: number): void; + /** + * 获取坐标的经度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLng(): number; + /** + * 设置坐标的纬度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLat(): void; + /** + * 获取坐标的纬度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLat(): number; + /** + * 判断两个坐标点是否相等 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + equals(pt: PlusMapsPoint): boolean; + /** + * 创建Point对象 + */ + constructor(lng: number, lat: number); +} + +/** + * 地理区域 + * 有西南及东北坐标点数据组成的矩形区域。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsBounds { + /** + * 设置地理区域的东北坐标点 + * 原方法名为setNorthEase，HBuilderX2.5.5+版本后已修正，原方法仍兼容支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setNorthEast(point: PlusMapsPoint): void; + /** + * 地理区域的东北坐标点 + * 原方法名为getNorthEase，HBuilderX2.5.5+版本后已修正，原方法仍兼容支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getNorthEast(): PlusMapsPoint; + /** + * 设置地理区域的西南坐标点 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setSouthWest(point: PlusMapsPoint): void; + /** + * 地理区域的西南坐标点 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getSouthWest(): PlusMapsPoint; + /** + * 判断制定的坐标是否在地理区域中 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + contains(point: PlusMapsPoint): boolean; + /** + * 判断两个地理区域是否相等 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + equals(bounds: PlusMapsBounds): boolean; + /** + * 获取地理区域的中心点坐标 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getCenter(): PlusMapsPoint; + /** + * 创建Bounds对象 + */ + constructor(northeast: PlusMapsPoint, southwest: PlusMapsPoint); + /** + * 创建Bounds对象 + */ + constructor(nelng: number, nelat: number, swlng: number, swlat: number); +} + +/** + * 地图视图类型 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsMapType { + /** + * 普通街道视图类型 + * 地图视图类型常量，普通街道视图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + MAPTYPE_NORMAL?: number; + /** + * 卫星视图 + * 地图视图类型常量，卫星视图。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + MAPTYPE_SATELLITE?: number; +} + +/** + * 地图覆盖物基类对象 + * Overlay是地图上显示元素的基类，用于抽象地图元素，不用于实例化。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsOverlay { + /** + * 判断地图覆盖物是否可见 + * 地图覆盖物对象默认为可见；地图覆盖物对象是否可见由其自身状态决定，不管其是否被添加到地图层中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + isVisible(): boolean; + /** + * 显示地图上的覆盖物 + * 常用于地图覆盖物在隐藏后调用此方法来显示。 + * 只有添加到地图上的覆盖物才能看到效果； + * 如果覆盖物对象已经在地图上显示再调用此方法将无效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + show(): void; + /** + * 隐藏地图上的覆盖物 + * 常用于地图覆盖物在显示后调用此方法来隐藏。 + * 只有添加到地图上的覆盖物才能看到效果； + * 如果覆盖物对象已经在地图上隐藏再调用此方法将无效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + hide(): void; +} + +/** + * 地图上显示的标点对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsMarker { + /** + * 用户点击地图标点事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onclick?: (result: PlusMapsOverlay) => void; + /** + * 用户拖拽标点事件 + * 可调用标点对象的markObj.setDraggable(true)方法设置标点允许拖拽，当用户拖拽标点对象时触发此事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onDrag?: (result: any) => void; + /** + * 覆盖物显示到最上层 + * 常用于覆盖物相互覆盖时调整覆盖物的显示顺序。 + * 只有添加到地图上的覆盖物才能看到效果； + * 如果覆盖物对象已经在地图上隐藏再调用此方法将无效果。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + bringToTop(): void; + /** + * 设置标点对象的坐标 + * 标点在设置新坐标后将在地图上立即更新标点位置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setPoint(point: PlusMapsPoint): void; + /** + * 获取标点的坐标 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getPoint(): PlusMapsPoint; + /** + * 设置标点上显示的图标 + * 若未设置则显示默认标点图标，已添加的标点在设置新值后将在地图上立即更新标点内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setIcon(icon: string): void; + /** + * 设置标点上显示的图标数组 + * 设置图标数组后则按照指定的间隔时间轮播数组中图标。 + * 设置图标数组后将忽略setIcon方法设置的图标，未设置则显示setIcon设置的图标。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setIcons(icons: string []): void; + /** + * 设置标点上显示的文本标注 + * 若未设置则不显示标注（默认为空字符串），已添加的标点在设置新值后将在地图上立即更新标点内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLabel(label: string): void; + /** + * 获取标点上显示的文本标注 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLabel(): string; + /** + * 设置标点的气泡内容 + * 设置气泡内容后，用户点击标点时弹出则弹出气泡。 + * 注意：用户点击标点时先弹出标点关联的气泡，再响应标点的onclick事件。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setBubble(buuble: PlusMapsBubble, pop?: boolean): void; + /** + * 获取标点上显示的文本标注 + * 如果没有设置关联的气泡对象则返回null。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getBubble(): PlusMapsBubble; + /** + * 隐藏标点上显示的气泡 + * 如果没有设置关联的气泡对象或者气泡对象没有弹出显示，则不做任何操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + hideBubble(): void; + /** + * 设置标点的是否允许拖拽 + * 设置标点可拖拽后，用户按住标点后拖动，标点会跟随手的拖拽而移动。 + * 拖拽后会更新标点的坐标信息。 + * 注：拖动前需要先在标点上长按。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setDraggable(draggable: boolean): void; + /** + * 获取标点是否允许拖拽 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + isDraggable(): boolean; + /** + * 创建地图标点Marker对象 + */ + constructor(point: PlusMapsPoint); +} + +/** + * 地图上显示的气泡对象 + * 此对象不能直接添加到地图上显示，只可关联到地图标点覆盖物上，用户点击标点时弹出显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsBubble { + /** + * 用户点击气泡事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onclick?: (result: PlusMapsOverlay) => void; + /** + * 设置气泡上显示的图标 + * 若为设置则无默认图标，已添加的显示的气泡在设置新值后将在地图上立即更新内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setIcon(icon: string): void; + /** + * 设置气泡上显示的文字内容 + * 若未设置则不显示文字（默认为空字符串），已添加的显示的气泡在设置新值后将在地图上立即更新内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLabel(label: string): void; + /** + * 获取气泡上显示的文字内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLabel(): string; + /** + * 获取气泡所属的标点对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + belongMarker(): PlusMapsMarker; + /** + * 从图片加载气泡显示的内容 + * 通过加载图片来自定义气泡显示的内容，加载图片后将清空气泡使用的图标及文字内容。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + loadImage(path: string): void; + /** + * 从图片数据加载气泡显示的内容 + * 通过加载图片数据来自定义气泡显示的内容，加载图片后将清空气泡使用的图标及文字内容。 + * 图片数据可通过Canvas自定义绘制后调用toDataURL来获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + loadImageDataURL(data: string): void; + /** + * 创建气泡对象 + */ + constructor(label: string); +} + +/** + * 地图上显示的圆圈对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsCircle { + /** + * 设置圆圈中心点的经纬度坐标 + * 该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setCenter(point: PlusMapsPoint): void; + /** + * 获取圆圈中心点的坐标 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getCenter(): PlusMapsPoint; + /** + * 设置圆圈的半径，单位为米 + * 该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setRadius(radius: number): void; + /** + * 获取圆圈的半径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getRadius(): number; + /** + * 设置圆圈的边框颜色 + * 圆圈默认的圆圈边框颜色为黑色"#000000"，该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStrokeColor(color: string): void; + /** + * 获取圆圈的边框颜色 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getStrokeColor(): string; + /** + * 设置圆圈的边框透明度 + * 圆圈默认值为不透明。 + * 如果设置的值不合法则保持原有的透明度；该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStrokeOpacity(opacity: number): void; + /** + * 获取圆圈边框的透明度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getStrokeOpacity(): number; + /** + * 设置圆圈的填充颜色 + * 圆圈默认的圆圈填充颜色为无色，该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setFillColor(color: string): void; + /** + * 获取圆圈的填充颜色 + * 如果填充颜色为无色，则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getFillColor(): string; + /** + * 设置圆圈填充颜色的透明度 + * 圆圈默认值为不透明。 + * 如果设置的值不合法则保持原有的透明度；该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setFillOpacity(opacity: number): void; + /** + * 获取圆圈填充色的透明度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getFillOpacity(): number; + /** + * 设置圆圈边框的线条宽度 + * 圆圈边框的默认值为5。 + * 如果设置的值不合法则保持原有的宽度；该方法设置将导致地图中的圆圈立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLineWidth(width: number): void; + /** + * 获取圆圈边框的线条宽度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLineWidth(): number; + /** + * 创建Circle对象 + */ + constructor(center: PlusMapsPoint, radius: number); +} + +/** + * 地图上显示的折线对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsPolyline { + /** + * 设置折线的顶点坐标 + * 该方法设置将导致地图中的折线立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setPath(points: any []): void; + /** + * 获取折线的顶点坐标 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getPath(): PlusMapsPoint []; + /** + * 设置折线的颜色 + * 折线默认的颜色为黑色"#000000"，该方法设置将导致地图中的折线立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStrokeColor(color: string): void; + /** + * 获取折线的颜色 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getStrokeColor(): string; + /** + * 设置折线的透明度 + * 折线默认值为不透明。 + * 如果设置的值不合法则保持原有的透明度；该方法设置将导致地图中的折线立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStrokeOpacity(opacity: number): void; + /** + * 获取折线的透明度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getStrokeOpacity(): number; + /** + * 设置折线的线条宽度 + * 折线线条的宽度默认值为5。 + * 如果设置的值不合法则保持原有的宽度；该方法设置将导致地图中的折线立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLineWidth(width: number): void; + /** + * 获取折线的线条宽度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLineWidth(): number; + /** + * 创建Polyline对象 + */ + constructor(points: any []); +} + +/** + * 地图上显示的多边形对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsPolygon { + /** + * 设置多边形的顶点坐标 + * 该方法设置将导致地图中的多边形立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setPath(points: any []): void; + /** + * 获取多边形的顶点坐标 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getPath(): PlusMapsPoint []; + /** + * 设置多边形的颜色 + * 多边形边框默认的颜色为黑色"#000000"，该方法设置将导致地图中的多边形立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStrokeColor(color: string): void; + /** + * 获取多边形边框的颜色 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getStrokeColor(): string; + /** + * 设置多边形的透明度 + * 多边形边框默认值为不透明。 + * 如果设置的值不合法则保持原有的透明度；该方法设置将导致地图中的多边形立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setStrokeOpacity(opacity: number): void; + /** + * 获取多边形边框的透明度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getStrokeOpacity(): number; + /** + * 设置多边形的填充颜色 + * 多边形默认填充颜色为无色，该方法设置将导致地图中的多边形立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setFillColor(color: string): void; + /** + * 获取多边形的填充色 + * 如果填充色为无色，则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getFillColor(): string; + /** + * 设置多边形填充色的透明度 + * 多边形填充色默认值为不透明。 + * 如果设置的值不合法则保持原有的透明度；该方法设置将导致地图中的多边形立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setFillOpacity(opacity: number): void; + /** + * 获取多边形填充色的透明度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getFillOpacity(): number; + /** + * 设置多边形的边框宽度 + * 多边形边框的宽度默认值为5。 + * 如果设置的值不合法则保持原有的宽度；该方法设置将导致地图中的多边形立即更新。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setLineWidth(width: number): void; + /** + * 获取多边形边框的宽度 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getLineWidth(): number; + /** + * 创建Polygon对象 + */ + constructor(points: any []); +} + +/** + * 地图检索对象 + * Search对象用于管理地图上的检索功能，包括位置检索、周边检索和范围检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsSearch { + /** + * 兴趣点检索完成事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onPoiSearchComplete?: (result0: number, result1: PlusMapsSearchPoiResult) => void; + /** + * 线路检索完成事件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + onRouteSearchComplete?: (result0: number, result1: PlusMapsSearchRouteResult) => void; + /** + * 设置检索返回结果每页的信息数目 + * 地图检索结果是按页返回的，默认检索每页返回10条信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setPageCapacity(capacity: number): void; + /** + * 获取检索返回结果每页的信息数目 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getPageCapacity(): number; + /** + * 城市兴趣点检索 + * 检索结果将通过onPoiSearchComplete事件返回。 + * 如果调用此方法时已经处于POI检索操作中，则终止上次检索操作，重新开始新的检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + poiSearchInCity(city: string, key: string, index?: number): boolean; + /** + * 周边检索 + * 周边检索根据中心点、半径与检索词进行检索，检索完成后触发onPoiSearchComplete()事件。 + * 若调用此方法时对象处于POI检索操作中，则终止上次检索操作，重新开始新的检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + poiSearchNearBy(key: string, pt: PlusMapsPoint, radius: number, index: number): boolean; + /** + * 指定范围检索 + * 根据范围和检索词进行检索，检索完成后触发onPoiSearchComplete()事件。 + * 若调用此方法时对象处于POI检索操作中，则终止上次检索操作，重新开始新的检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + poiSearchInbounds(key: string, ptLB: PlusMapsPoint, ptRT: PlusMapsPoint, index: number): boolean; + /** + * 设置公交路线检索策略 + * 默认采用maps.SearchPolicy.TRANSIT_TIME_FIRST策略。 + * 需在调用transitSearch()方法前设置的策略才生效； + * 如果设置非法值则认为设置失败，采用上次设置的检索策略并返回false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setTransitPolicy(policy: PlusMapsSearchPolicy): boolean; + /** + * 公交路线检索 + * 检索完成后触发onRouteSearchComplete()事件。 + * 若调用此方法时对象处于检索操作中，则终止上次检索操作，重新开始新的检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + transitSearch(start: string | PlusMapsPoint, end: string | PlusMapsPoint, city: string): boolean; + /** + * 设置驾车路线检索策略 + * 设置驾车路线检索策略，默认采用maps.SearchPolicy.DRIVING_TIME_FIRST策略。 + * 如果设置非法值则认为设置失败，采用上次设置的检索策略并返回false；需在调用drivingSearch()方法前设置的策略才生效。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + setDrivingPolicy(policy: PlusMapsSearchPolicy): boolean; + /** + * 驾车路线检索 + * 用于驾车路线检索，检索完成后触发onRouteSearchComplete()事件。 + * 调用此方法时对象处于检索操作中，则终止上次检索操作，重新开始新的检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + drivingSearch(start: string | PlusMapsPoint, startCity: string, end: string | PlusMapsPoint, endCity: string): boolean; + /** + * 步行路线检索 + * 用于步行路线检索，检索完成后触发onRouteSearchComplete()事件。 + * 调用此方法时对象处于检索操作中，则终止上次检索操作，重新开始新的检索。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + walkingSearch(start: string | PlusMapsPoint, startCity: string, end: string | PlusMapsPoint, endCity: string): boolean; + /** + * 创建Search对象 + */ + constructor(map: PlusMapsMap); +} + +/** + * 检索策略类型 + * 在线路检索时设置检索策略时使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsSearchPolicy { + /** + * 时间优先 + * 检索策略类型常量，用于公交检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + TRANSIT_TIME_FIRST?: number; + /** + * 最少换乘优先 + * 检索策略类型常量，用于公交检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + TRANSIT_TRANSFER_FIRST?: number; + /** + * 最少步行距离优先 + * 检索策略类型常量，用于公交检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + TRANSIT_WALK_FIRST?: number; + /** + * 选择车票花销最少优先 + * 检索策略类型常量，用于公交检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + TRANSIT_FEE_FIRST?: number; + /** + * 最短距离优先 + * 检索策略类型常量，用于驾车检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + DRIVING_DIS_FIRST?: number; + /** + * 无高速公路线路 + * 检索策略类型常量，用于驾车检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + DRIVING_NO_EXPRESSWAY?: number; + /** + * 最少费用优先 + * 检索策略类型常量，用于驾车检索策略 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + DRIVING_FEE_FIRST?: number; +} + +/** + * 保存位置检索、周边检索和范围检索返回的结果 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsSearchPoiResult { + /** + * POI检索总结果数 + * POI检索总结果数，若没有检索到则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + totalNumber?: number; + /** + * 当前页的POI检索结果数 + * 当前页POI检索结果数，若没有检索到则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + currentNumber?: number; + /** + * 本次POI检索的总页数 + * 本次POI检索的总页数，若没有检索到则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + pageNumber?: number; + /** + * 获取当前页的索引 + * 当前页的索引值，从0开始，即0表示第一页。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + pageIndex?: number; + /** + * 本次POI检索结果数组 + * POI检索结果数组，Array数组对象，数组内容为Position对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + poiList?: any []; + /** + * 获取指定索引的检索结果 + * 如果index值超出范围则返回null对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getPosition(): PlusMapsPosition; +} + +/** + * 保存位置检索、周边检索和范围检索返回的结果 + * 不可通过new操作符创建SearchRouteResult对象，在触发onRouteSearchComplete()时自动创建。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +interface PlusMapsSearchRouteResult { + /** + * 线路的起点位置 + * 线路检索结果的起始位置点对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + startPosition?: PlusMapsPosition; + /** + * 线路的终点位置 + * 线路检索结果的终点位置点对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + endPosition?: PlusMapsPosition; + /** + * 本次线路检索的总方案数 + * 线路检索结果的方案数目，若未检索到有效结果则返回0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + routeNumber?: number; + /** + * 线路检索结果数组 + * 线路检索结果数组，Array数组对象，数组内容为Route对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + routeList?: any []; + /** + * 获取指定索引的线路方案 + * 如果index值超出范围则返回null对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + getRoute(index: number): PlusMapsRoute; +} + +/** + * 检索结果的位置点 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsPosition { + /** + * 位置点的经纬度坐标 + * 如果没有经纬度坐标信息（如果公交、地铁路线数据等），则其值为undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + point?: PlusMapsPoint; + /** + * 位置点的地址信息 + * 如果没有位置点的地址信息则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + address?: string; + /** + * 位置点的所属城市信息 + * 如果没有位置点的所属城市信息则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + city?: string; + /** + * 位置点的名称 + * 如果没有位置点的名称则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + name?: string; + /** + * 位置点的电话信息 + * 如果没有位置点的电话信息则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + phone?: string; + /** + * 位置点的邮编信息 + * 如果没有位置点的邮编信息则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + postcode?: string; + /** + * 创建Position对象 + */ + constructor(point: PlusMapsPoint); +} + +/** + * 地图中的路线对象 + * 从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ +declare class PlusMapsRoute { + /** + * 路线起点地理坐标点 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + startPoint?: PlusMapsPoint; + /** + * 路线终点地理坐标点 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + endPoint?: PlusMapsPoint; + /** + * 路线坐标点段数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + pointCount?: PlusMapsPoint; + /** + * 路线的地理坐标点数组 + * 路线的地理坐标点数组，数组中保存Point对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + pointList?: any []; + /** + * 路线总距离 + * 路线从起始点到终点的距离，单位为米。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + distance?: number; + /** + * 线路的提示信息 + * 线路提示信息，没有提示信息则返回空字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/maps.html](http://www.html5plus.org/doc/zh_cn/maps.html) + */ + routeTip?: string; + /** + * 创建Route对象 + */ + constructor(ptStart: PlusMapsPoint, ptEnd: PlusMapsPoint); +} + +/** + * OAuth模块管理客户端的用户登录鉴权功能，允许应用访问第三方平台的资源。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauth { + /** + * 登录鉴权服务对象 + * AuthService对象用于表示登录鉴权服务，在JS中为对象，用于发起登录授权认证操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + AuthService?: PlusOauthAuthService; + /** + * 苹果登录认证信息 + * 此对象仅在使用苹果登录时有效，用于保存苹果登录返回的数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + AppleInfo?: PlusOauthAppleInfo; + /** + * JSON对象，授权认证参数选项 + * 此对象支持的属性值由登录授权认证服务定义。 + * 例如“微信”，则可配置以下参数： + * scope - 应用授权作用域； + * state - 用于保持请求和回调的状态参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + AuthOptions?: PlusOauthAuthOptions; + /** + * 登录授权认证信息 + * 此对象仅定义标准属性，登录授权认证服务可扩展自定义数据。 + * 例如“微信”登录授权服务，则包括以下数据： + * unionid - 用户统一标识，针对一个微信开放平台帐号下的应用，同一用户的unionid是唯一的。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + AuthInfo?: PlusOauthAuthInfo; + /** + * 登录授权用户信息 + *

+ * 用于保存登录授权用户的信息。 + * 此对象仅定义标准属性，登录授权认证服务可扩展自定义数据。 + * 例如“微信”登录授权服务，可能包括以下自定义数据： + *

    + *
  • privilege - 用户特权信息，json数组，如微信沃卡用户为（chinaunicom）
    • + *
+ * unionid - ，。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UserInfo?: PlusOauthUserInfo; + /** + * 一键登录授权界面样式参数 + *

+ * 用于一键登录授权界面自定义样式。 + * HBuilderX3.0.0+版本支持，详情参考一键登录使用指南。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyStyles?: PlusOauthUniverifyStyles; + /** + * 一键登录授权界面图标样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyIconStyles?: PlusOauthUniverifyIconStyles; + /** + * 一键登录授权界面电话号码文本样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyPhoneNumStyles?: PlusOauthUniverifyPhoneNumStyles; + /** + * 一键登录授权界面服务说明文字样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifySloganStyles?: PlusOauthUniverifySloganStyles; + /** + * 一键登录授权界面登录按钮样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyAuthButtonStyles?: PlusOauthUniverifyAuthButtonStyles; + /** + * 一键登录授权界面其它按钮样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyOtherButtonStyles?: PlusOauthUniverifyOtherButtonStyles; + /** + * 一键登录服务协议样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyPrivacyTermsStyles?: PlusOauthUniverifyPrivacyTermsStyles; + /** + * 自定义服务协议链接样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniverifyPrivacyItemStyles?: PlusOauthUniverifyPrivacyItemStyles; + /** + * 自定义登录按钮列表样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniVerifyButtonsStyles?: PlusOauthUniVerifyButtonsStyles; + /** + * 自定义登录按钮样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + UniVerifyButtonStyles?: PlusOauthUniVerifyButtonStyles; + /** + * 获取登录鉴权列表 + * 获取终端支持的权登录认证服务列表，可用于提示用户进行登录平台的选择。 + * 获取登录鉴权成功后通过successCB回调返回支持的所有服务列表，获取服务失败则通过errorCB回调返回失败信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + getServices(successCB: (result: PlusOauthAuthService []) => void, errorCB?: (result: any) => void): void; +} + +/** + * 登录鉴权服务对象 + * AuthService对象用于表示登录鉴权服务，在JS中为对象，用于发起登录授权认证操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthAuthService { + /** + * 登录鉴权服务标识 + *

+ * 用于表示登录鉴权服务标识： + *

    + *
  • "weixin" - 表示微信登录鉴权
    • + *
  • "qq" - 表示QQ登录鉴权
    • + *
  • "sinaweibo" - 表示新浪微博登录鉴权
    • + *
  • "xiaomi" - 表示小米登录鉴权
    • + *
  • "apple" - 表示苹果登录（仅iOS13+系统支持）
    • + *
  • "univerify" - 表示一键登录（HBuilderX3.0.0+版本支持），详情参考一键登录使用指南
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + id?: string; + /** + * 登录鉴权服务描述 + *

+ * 用于描述登录鉴权服务的信息： + *

    + *
  • "微信" - 表示微信登录鉴权；
    • + *
  • "QQ" - 表示QQ登录鉴权；
    • + *
  • "新浪微博" - 表示新浪微博登录鉴权；
    • + *
  • "小米" - 表示小米登录鉴权；
    • + *
  • "Apple" - 表示苹果登录；
    • + *
  • "一键登录" - 表示一键登录（HBuilderX3.0.0+版本支持），详情参考一键登录使用指南
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + description?: string; + /** + * 授权登录依赖的客户端App是否已安装 + *

+ * 对于某些登录鉴权服务，必须依赖相应客户端App才能实现授权操作；有些登录鉴权服务则无需客户端App，或者依赖的客户端App不存在时调用WAP页面进行授权操作。 + * 具体情况如下： + *

    + *
  • 微信 - 依赖微信客户端App
    • + *
  • QQ - 依赖QQ客户端App
    • + *
  • 新浪微博 - 不依赖微博客户端App，不存在是调用WAP页面登录授权操作
    • + *
  • 小米登录 - 无需客户端App
    • + *
  • 苹果登录 - 无需客户端App
    • + *
  • 一键登录 - 无需客户端App
    • + *
+ * 注意：提交AppStore审核时没有安装相应的客户端App可能导致无法通过审核，此时需要判断相应的客户端App是否安装，如果没有安装则不显示对应的登录入口。 + * HBuilderX3.1.19及以上版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + nativeClient?: boolean; + /** + * 苹果登录认证数据 + * 调用login登录认证成功后保存的苹果认证信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + appleInfo?: PlusOauthAppleInfo; + /** + * 登录认证数据 + * 调用login登录认证成功后保存的认证信息。 + * 如果值为"undefined"则表示未进行登录认证或者登录认证失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + authResult?: PlusOauthAuthInfo; + /** + * 登录用户信息 + * 调用用于保存登录授权认证获取的用户信息，如果值为"undefined"则表示未获取过用户信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + userInfo?: PlusOauthUserInfo; + /** + * 登录授权认证扩展信息 + * 用于保存登录鉴权服务返回的扩展信息，具体内容由各登录平台决定，如果没有扩展信息则为undefined。 + * 例如“微信”，则可保存以下数据： + * state - 用于保持请求和回调的状态参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + extra?: any; + /** + * 请求授权认证 + * 向开放平台请求进行授权认证，需提供授权域（scope），用户在终端确认后通过成功回调返回授权临时票据（code）。 + * 开发者可以将授权临时票据（code）提交到业务服务器，由业务服务器从微信开放平台获取授权登录等相关信息，避免将appsecret等信息保存在客户端可能引起泄露的问题。 + * 注意：目前仅微信平台支持请求授权认证，其它平台调用此方法将返回错误回调。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + authorize(successCallback: (result: any) => void, errorCallback?: (result: any) => void, options?: PlusOauthAuthOptions): void; + /** + * 关闭授权登录界面 + *

+ * 仅一键登录支持，请求登录认证操作完成后，不管成功或失败都不会关闭一键登录界面，需要主动调用此方法关闭。 + * 客户端登录认证完成只是说明获取 access_token 成功，需要将此数据提交到服务器获取手机号码，完成业务服务登录逻辑后通知客户端关闭登录界面。 + * 详情参考https://uniapp.dcloud.io/univerify + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + closeAuthView(): void; + /** + * 请求登录认证 + *

+ * 在登录前可通过对象的authResult属性判断是否已经登录认证过，通常只需对没有登录认证过的服务进行此操作。 + * 登录后可获取应用的基础信息（如用户昵称等）保存在authResult属性中。 + * 登录操作成功后通过successCallback回调函数通知，失败则通过errorCallback回调函数通知。 + * 注意，由于业务需求的差异，不同授权登录平台返回数据的处理逻辑可能不同： + *

    + *
  • 微信登录 - 在客户端配置appSecret可能存在参数泄露的隐患，可以在客户端获取授权临时票据（code）后提交到业务服务器，有业务服务器向微信开放平台获取详细信息，详情参考https://ask.dcloud.net.cn/article/192
    • + *
  • 一键登录 - 授权登录在客户端仅可以openid和access_token，需要将此数据提交业务服务器换手机号码，详情参考https://uniapp.dcloud.io/univerify
    • + *
+ *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + login(successCallback: (result: any) => void, errorCallback?: (result: any) => void, options?: PlusOauthAuthOptions): void; + /** + * 注销登录认证 + * 注销登录认证后，再次获取用户信息时需重新进行授权登录认证操作。 + * 如果第三方平台不需要注销登录操作，则清空保存的登录认证等信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + logout(successCallback: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 获取用户信息 + * 在获取用户信息前可通过对象的userInfo属性判断是否已经获取过，通常只需对没有获取过用户信息的服务进行此操作。 + * 获取用户信息成功后通过successCallback回调函数通知，失败则通过errorCallback回调函数通知。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + getUserInfo(successCallback: (result: any) => void, errorCallback?: (result: any) => void): void; + /** + * 预登录 + * 仅一键登录支持，在登录授权认证前调用，可以判断当前设备环境是否支持一键登录，如果能支持一键登录，此时可以显示一键登录选项，同时预登录会准备好相关环境，显著提升一键登录授权认证的操作速度。 + * 如果预登录失败，表示当前设备环境可能不支持一键登录，此时应该显示其他登录选项。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + preLogin(successCallback: (result: any) => void, errorCallback?: (result: any) => void): void; +} + +/** + * 苹果登录认证信息 + * 此对象仅在使用苹果登录时有效，用于保存苹果登录返回的数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthAppleInfo { + /** + * 苹果用户唯一标识符 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + user?: string; + /** + * 验证信息状态 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + state?: string; + /** + * 用户共享的可选电子邮件 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + email?: string; + /** + * 用户共享的可选全名 + * 可能包括以下属性： + * namePrefix - String类型，名字前缀，头衔、敬称； + * givenName - String类型，名字； + * middleName - String类型，中间名； + * familyName - String类型，姓； + * nameSuffix - String类型，名字后缀，学位、荣誉； + * nickName - String类型，昵称。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + fullName?: any; + /** + * 验证数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + authorizationCode?: string; + /** + * Web令牌(JWT) + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + identityToken?: string; + /** + * 标识用户是否为真实的人 + * 0 - 当前平台不支持，忽略该值； + * 1 - 无法确认； + * 2 - 用户真实性非常高。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + realUserStatus?: number; +} + +/** + * JSON对象，授权认证参数选项 + * 此对象支持的属性值由登录授权认证服务定义。 + * 例如“微信”，则可配置以下参数： + * scope - 应用授权作用域； + * state - 用于保持请求和回调的状态参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthAuthOptions { + /** + * 申请的权限作用范围 + * 如果存在多个权限，则以","符号分割。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + scope?: string; + /** + * 客户端的当前状态，可以指定任意值，登录认证后原封不动的返回保存到AuthService对象的extra中 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + state?: string; + /** + * 登录授权认证服务平台申请的appid + * 动态设置登录授权服务中需要使用的appid，仅需要此参数的登录授权服务（如“微信登录”、“QQ登录”）支持。 + * 如果未设置则使用运行环境中内置的appid值（如在HBuilder中可在manifest.json的SDK配置项中进行设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + appid?: string; + /** + * 登录授权认证服务平台申请的appkey + * 动态设置登录授权服务中需要使用的appkey，仅需要此参数的登录授权服务（如“新浪微博登录”）支持。 + * 如果未设置则使用运行环境中内置的appkey值（如在HBuilder中可在manifest.json的SDK配置项中进行设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + appkey?: string; + /** + * 登录授权认证服务平台申请的appsecret + * 动态设置登录授权服务中需要使用的appsecret，仅需要此参数的登录授权服务（如“微信登录”、“新浪微博登录”）支持。 + * 如果未设置则使用运行环境中内置的appkey值（如在HBuilder中可在manifest.json的SDK配置项中进行设置）； + * 当开放平台申请的appsecret值涉及到安全问题时，可在应用运行时从服务器获取，然后通过此api动态设置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + appsecret?: string; + /** + * 登录授权认证服务平台申请的redirect_url + * 动态设置登录授权服务中需要使用的redirect_url，仅需要此参数的登录授权服务（如“新浪微博登录”）支持。 + * 如果未设置则使用运行环境中内置的redirect_url值（如在HBuilder中可在manifest.json的SDK配置项中进行设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + redirect_url?: string; + /** + * 一键登录授权界面自定义样式 + *

+ * HBuilderX3.0.0+支持一键登录，此参数用于设置一键登录的授权界面样式，参考UniverifyStyles + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + univerifyStyle?: PlusOauthUniverifyStyles; +} + +/** + * 登录授权认证信息 + * 此对象仅定义标准属性，登录授权认证服务可扩展自定义数据。 + * 例如“微信”登录授权服务，则包括以下数据： + * unionid - 用户统一标识，针对一个微信开放平台帐号下的应用，同一用户的unionid是唯一的。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthAuthInfo { + /** + * 登录授权的访问令牌 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + access_token?: string; + /** + * 登录授权用户的唯一标识 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + openid?: string; + /** + * 登录授权访问令牌过期时间 + * 单位为秒，如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + expires_in?: string; + /** + * 登录授权的更新令牌 + * 用来获取下一次的访问令牌，如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + refresh_token?: string; + /** + * 登录授权的权限范围 + * 如果存在多个权限，则以","符号分割。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + scope?: string; +} + +/** + * 登录授权用户信息 + *

+ * 用于保存登录授权用户的信息。 + * 此对象仅定义标准属性，登录授权认证服务可扩展自定义数据。 + * 例如“微信”登录授权服务，可能包括以下自定义数据： + *

    + *
  • privilege - 用户特权信息，json数组，如微信沃卡用户为（chinaunicom）
    • + *
+ * unionid - ，。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUserInfo { + /** + * 登录授权用户的唯一标识 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + openid?: string; + /** + * 登录授权用户的头像图片地址 + * 要求为"http://"或"https://"开头的地址，如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + headimgurl?: string; + /** + * 登录授权用户的昵称 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + nickname?: string; + /** + * 登录授权用户的邮箱地址 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + email?: string; + /** + * 登录授权用户的电话号码 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + phonenumber?: string; + /** + * 登录授权用户的性别 + * 1为男性，2为女性。 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + sex?: string; + /** + * 登录授权用户注册的省份信息 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + province?: string; + /** + * 登录授权用户注册的城市信息 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + city?: string; + /** + * 登录授权用户注册的国家信息 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + country?: string; + /** + * 用户统一标识 + *

+ * 针对同一个登录授权服务平台帐号下的应用，同一用户的unionid是唯一的。 + * 如果登录授权服务不支持此属性，则返回"undefined"。 + * 注意：仅微信及QQ平台支持，QQ平台HBuilderX3.0.0+版本支持，需在QQ开放平台申请才能获取。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + unionid?: string; +} + +/** + * 一键登录授权界面样式参数 + *

+ * 用于一键登录授权界面自定义样式。 + * HBuilderX3.0.0+版本支持，详情参考一键登录使用指南。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyStyles { + /** + * 是否全屏模式 + *

+ * true表示全屏模式，false表示非全屏模式，默认值为false。 + * 注意：HBuilderX3.1.5+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + fullScreen?: boolean; + /** + * 授权界面背景颜色 + * 格式为"#RRGGBB"，默认值为"#FFFFF"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + backgroundColor?: string; + /** + * 背景图片 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + backgroundImage?: string; + /** + * 授权界面图标样式 + * 可设置自定义图标，默认为应用图标。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + icon?: PlusOauthUniverifyIconStyles; + /** + * 授权界面电话号码样式 + * 可设置自定义电话号码文字颜色、大小等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + phoneNum?: PlusOauthUniverifyPhoneNumStyles; + /** + * 授权界面服务说明样式 + * 可设置自定义服务说明文字颜色、大小等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + slogan?: PlusOauthUniverifySloganStyles; + /** + * 授权界面登录按钮样式 + * 可设置自定义登录按钮背景颜色、文本内容、大小等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + authButton?: PlusOauthUniverifyAuthButtonStyles; + /** + * 授权界面其他登录按钮样式 + * 可设置自定义其他登录按钮背景颜色、文本内容、大小等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + otherLoginButton?: PlusOauthUniverifyOtherButtonStyles; + /** + * 授权界面服务协议样式 + * 自定义设置服务器协议文字颜色、文本内容，添加自定义服务协议链接等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + privacyTerms?: PlusOauthUniverifyPrivacyTermsStyles; + /** + * 自定义登录按钮列表样式 + *

+ * 自定义设置更多登录按钮列表，如其它三方登录等。 + * 注意：HBuilderX3.1.14+版本支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + buttons?: PlusOauthUniVerifyButtonsStyles; +} + +/** + * 一键登录授权界面图标样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyIconStyles { + /** + * 图标地址 + * 仅支持本地路径，默认为应用图标。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + path?: string; + /** + * 图标宽度 + * 格式为“XXpx"，默认值为"60px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + width?: string; + /** + * 图标高度 + * 格式为“XXpx"，默认值为"60px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + height?: string; +} + +/** + * 一键登录授权界面电话号码文本样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyPhoneNumStyles { + /** + * 字体颜色 + * 格式为"#RRGGBB"，默认值为"#000000"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + color?: string; + /** + * 字体大小 + * 格式为“XXpx"，默认值为"18px"。注意：字体加粗显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + fontSize?: string; +} + +/** + * 一键登录授权界面服务说明文字样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifySloganStyles { + /** + * 字体颜色 + * 格式为"#RRGGBB"，默认值为"#8a8b90"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + color?: string; + /** + * 字体大小 + * 格式为“XXpx"，默认值为"12px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + fontSize?: string; +} + +/** + * 一键登录授权界面登录按钮样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyAuthButtonStyles { + /** + * 正常状态按钮颜色 + * 格式为"#RRGGBB"，默认值为"#3479f5"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + normalColor?: string; + /** + * 按下状态按钮颜色 + * 格式为"#RRGGBB"，默认值为"#2861c5"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + highlightColor?: string; + /** + * 不可点击状态按钮颜色 + * 格式为"#RRGGBB"，默认值为"#73aaf5"。 + * 注意：仅iOS平台支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + disabledColor?: string; + /** + * 按钮宽度 + * 格式为“XXpx"，默认值为自适应，距离屏幕左右"32px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + width?: string; + /** + * 按钮高度 + * 格式为“XXpx"，默认值为"94px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + height?: string; + /** + * 按钮上文字颜色 + * 格式为"#RRGGBB"，默认值为"#ffffff"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + textColor?: string; + /** + * 按钮上文字内容 + * 默认值为"本机号码一键登录"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + title?: string; + /** + * 按钮圆角半径 + * 格式为“XXpx"，默认值为按钮高度的一半。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + borderRadius?: string; +} + +/** + * 一键登录授权界面其它按钮样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyOtherButtonStyles { + /** + * 是否显示其它按钮 + * 可取值： true - 显示其它按钮；false - 不显示其它按钮。 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + visible?: boolean; + /** + * 正常状态按钮颜色 + * 格式为"#RRGGBB"，默认值为"#f8f8f8"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + normalColor?: string; + /** + * 按下状态按钮颜色 + * 格式为"#RRGGBB"，默认值为"#dedede"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + highlightColor?: string; + /** + * 按钮宽度 + * 格式为“XXpx"，默认值为自适应，距离屏幕左右"32px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + width?: string; + /** + * 按钮高度 + * 格式为“XXpx"，默认值为"94px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + height?: string; + /** + * 按钮上文字颜色 + * 格式为"#RRGGBB"，默认值为"#000000"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + textColor?: string; + /** + * 按钮上文字内容 + * 默认值为"其他登录方式"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + title?: string; + /** + * 按钮边框宽度 + * 格式为“XXpx"，默认值为"1px"。 + * 注意：仅iOS平台支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + borderWidth?: string; + /** + * 按钮边框颜色 + * 格式为"#RRGGBB"，默认值为"#c5c5c5"。 + * 注意：仅iOS平台支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + borderColor?: string; + /** + * 按钮圆角半径 + * 格式为“XXpx"，默认值为按钮高度的一半。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + borderRadius?: string; +} + +/** + * 一键登录服务协议样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyPrivacyTermsStyles { + /** + * 默认是否勾选同意协议选择框 + *

+ * ture表示勾选，false表示不勾选。默认值为true。 + * HBuilderX3.1.0+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + defaultCheckBoxState?: boolean; + /** + * 未勾选同意协议选择框的图片地址 + *

+ * 仅支持本地路径，建议图片尺寸24x24px。 + * HBuilderX3.1.23+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + uncheckedImage?: string; + /** + * 勾选同意协议选择框的图片地址 + *

+ * 仅支持本地路径，建议图片尺寸24x24px。 + * HBuilderX3.1.23+版本新增支持。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + checkedImage?: string; + /** + * 普通文字颜色 + * 格式为"#RRGGBB"，默认值为"#8a8b90"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + textColor?: string; + /** + * 协议链接文字颜色 + * 格式为"#RRGGBB"，默认值为"#1d4788"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + termsColor?: string; + /** + * 服务协议前文本内容 + * 默认值为"我已阅读并同意"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + prefix?: string; + /** + * 服务协议后文本内容 + * 默认值为"并使用本机号码登录"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + suffix?: string; + /** + * 字体大小 + * 格式为“XXpx"，默认值为"12px"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + fontSize?: string; + /** + * 服务协议 + * 自定义服务协议，可设置使用手机号码登录的协议，最多可设置两个协议。 + * 注意：运营商的服务协议链接会自动添加到自定义服务协议之前。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + privacyItems?: PlusOauthUniverifyPrivacyItemStyles []; +} + +/** + * 自定义服务协议链接样式参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniverifyPrivacyItemStyles { + /** + * 链接地址 + * http/https开头的协议链接地址。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + url?: string; + /** + * 协议链接文字 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + title?: string; +} + +/** + * 自定义登录按钮列表样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniVerifyButtonsStyles { + /** + * 自定义登录按钮图标宽度 + *

+ * 单位为px，默认值为45px。 + * 按指定宽度缩放，高度等比例缩放。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + iconWidth?: string; + /** + * 自定义登录按钮列表 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + list?: any []; +} + +/** + * 自定义登录按钮样式 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ +interface PlusOauthUniVerifyButtonStyles { + /** + * 自定义按钮图标路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + iconPath?: string; + /** + * 点击按钮回调函数 + * 用户点击按钮时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/oauth.html](http://www.html5plus.org/doc/zh_cn/oauth.html) + */ + onclick?: () => void; +} + +/** + * Payment模块管理支付功能，用于提供网页安全支付能力，支持通过Web接口进行支付操作。通过plus.payment可获取支付管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPayment { + /** + * 支付通道对象 + * PaymentChannel对象表示特定的支付通道，用于向系统请求支付操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + PaymentChannel?: PlusPaymentPaymentChannel; + /** + * IAP订单数据对象 + * 描述IAP商品订单信息，如标识、数量等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + OrderStatementIAP?: PlusPaymentOrderStatementIAP; + /** + * 支付操作结果对象 + * PaymentResult对象表示支付操作返回结果，用于确认支付操作成功。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + PaymentResult?: PlusPaymentPaymentResult; + /** + * IAP商品对象 + * 描述IAP商品详细信息，如标识、价格、标题、描述信息等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + IAPProduct?: PlusPaymentIAPProduct; + /** + * 购买IAP商品对象 + * 描述购买的IAP商品详细信息，如标识、数量等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + IAPProductInfo?: PlusPaymentIAPProductInfo; + /** + * 购买IAP商品交易信息对象 + * 描述购买的IAP商品交易详细信息，如购买商品信息、交易日期、订单标识等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + IAPTransaction?: PlusPaymentIAPTransaction; + /** + * 获取支付通道 + * 在进行支付操作前需获取终端支持的支付通道列表，用于提示用户进行选择。 + * 获取支付通道成功后通过successCB回调返回支持的所有通道列表，获取支付通道列表失败则通过errorCB回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + getChannels(successCB: (result: PlusPaymentPaymentChannel []) => void, errorCB?: (result: any) => void): void; + /** + * 请求支付操作 + * 调用指定的支付通道进行支付操作，其中statement包含支付操作的相关信息，支付模块将弹出支付界面供用户进行支付信息的输入确认操作。 + * 用户支付操作成功后通过successCB回调返回支付操作结果，支付操作失败则通过errorCB回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + request(channel: PlusPaymentPaymentChannel, statement: string | object | PlusPaymentOrderStatementIAP, successCB?: (result: PlusPaymentPaymentResult) => void, errorCB?: (result: any) => void): void; +} + +/** + * 支付通道对象 + * PaymentChannel对象表示特定的支付通道，用于向系统请求支付操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPaymentPaymentChannel { + /** + * 支付通道标识 + * 用于标识支付通道： + * "alipay" - 表示支付宝； + * "wxpay" - 表示微信支付； + * "appleiap" - 表示苹果应用内支付； + * "qhpay" - 表示360聚合支付（仅360手助流应用环境下支持）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + id?: string; + /** + * 支付通道描述 + * 支付通道的描述信息，如“支付宝”、“微信”、“In-App Purchase”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + description?: string; + /** + * 支付通道服务是否安装 + * 通常特定的支付通道依赖系统安装相关的服务，此属性用于标识其服务是否安装，如果没有安装则为false，否则为true。 + * 若系统环境中没有安装相关的服务，则可能导致调用支付操作失败，这时可以调用installService方法进行安装。 + * 注意：如果支付通道不需要依赖系统安装服务，则永远返回true。例如支付宝，如果设备上未安装支付宝客户端则调用Wap页面进行支付，因此值固定返回true； + * 而微信支付则依赖微信客户端，如果设备上未安装微信客户端则serviceReady值为false，此时应该提示用户安装微信客户端才能进行支付操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + serviceReady?: boolean; + /** + * 安装支付通道依赖的服务 + * 对于某些支付通道，通常特定的支付通道依赖系统安装相关的服务，调用此方法将安装其依赖的支付服务。 + * 如支付宝，则在系统中安装支付宝客户端程序。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + installService(): void; + /** + * 向IAP服务器请求支付订单 + * IAP支付在调用plus.payment.request方法支付前须先向服务器请求获取商品的详细信息，否则会支付失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + requestOrder(ids?: string [], successCB?: (result: PlusPaymentIAPProduct []) => void, errorCB?: (result: any) => void): void; + /** + * 向IAP服务器请求已经购买的非消耗性商品和订阅商品 + * 注意：不能获取已购买的消耗性商品。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + restoreComplateRequest(options?: any, successCB?: (result: PlusPaymentIAPTransaction []) => void): void; +} + +/** + * IAP订单数据对象 + * 描述IAP商品订单信息，如标识、数量等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPaymentOrderStatementIAP { + /** + * 商品的标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + productid?: string; + /** + * 购买用户名称 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + username?: string; + /** + * 商品数量 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + quantity?: string; +} + +/** + * 支付操作结果对象 + * PaymentResult对象表示支付操作返回结果，用于确认支付操作成功。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPaymentPaymentResult { + /** + * 支付通道对象 + * 用于发起支付操作的支付通道对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + channel?: PlusPaymentPaymentChannel; + /** + * 交易编号信息 + * 如果支付平台不支持此数据则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + tradeno?: string; + /** + * 交易描述信息 + * 如果支付平台不支持此数据则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + description?: boolean; + /** + * 查找支付交易信息地址 + * 用于向支付平台查询交易信息，如果支付平台不支持此数据则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + url?: boolean; + /** + * 支付操作指纹信息 + * 用于向支付平台查询支付订单信息，如果支付平台不支持此数据则返回undefined。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + signature?: string; + /** + * 支付平台返回的原始数据 + * 如果支付平台返回key-value类型字符串，则组合成符合JSON格式的字符串。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + rawdata?: string; +} + +/** + * IAP商品对象 + * 描述IAP商品详细信息，如标识、价格、标题、描述信息等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPaymentIAPProduct { + /** + * 商品的标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + productid?: string; + /** + * 商品的价格 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + price?: string; + /** + * 商品标题 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + title?: string; + /** + * 商品的描述信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + description?: string; +} + +/** + * 购买IAP商品对象 + * 描述购买的IAP商品详细信息，如标识、数量等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPaymentIAPProductInfo { + /** + * 商品的标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + productIdentifier?: string; + /** + * 商品的数量 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + quantity?: string; +} + +/** + * 购买IAP商品交易信息对象 + * 描述购买的IAP商品交易详细信息，如购买商品信息、交易日期、订单标识等。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ +interface PlusPaymentIAPTransaction { + /** + * 购买商品的信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + payment?: string; + /** + * 购买商品的交易日期 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + transactionDate?: string; + /** + * 购买商品的交易订单标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + transactionIdentifier?: string; + /** + * 购买商品的交易收据 + * base64编码格式字符串数据。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + transactionReceipt?: string; + /** + * 购买商品的交易状态 + * 可取值："1"为支付成功；"2"为支付失败；"3"为支付已恢复。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/payment.html](http://www.html5plus.org/doc/zh_cn/payment.html) + */ + transactionState?: string; +} + +/** + * Push模块管理推送消息功能，可以实现在线、离线的消息推送，通过plus.push可获取推送消息管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ +interface PlusPush { + /** + * JSON对象，获取的客户端标识信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + ClientInfo?: PlusPushClientInfo; + /** + * JSON对象，推送消息对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + PushMessage?: PlusPushPushMessage; + /** + * JSON对象，获客户端创建本地消息的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + MessageOptions?: PlusPushMessageOptions; + /** + * 添加推送消息事件监听器 + * 添加推送消息事件监听器，当指定推送事件发出时触发。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + addEventListener(type: 'click' | 'receive', listener: (result: string) => void, capture?: boolean): void; + /** + * 清空所有推送消息 + * 清空系统消息中心所有的推送消息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + clear(): void; + /** + * 创建本地消息 + * 在本地直接创建推送消息，并添加到系统消息中心。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + createMessage(content: string, payload?: string, options?: PlusPushMessageOptions): void; + /** + * 获取所有推送消息 + * 获取客户端接收到的所有推送消息。 + * 仅包括在系统消息中心显示的推送消息，不包括调用setAutoNotification(false)方法设置不显示推送消息后接收到的消息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + getAllMessage(): PlusPushPushMessage; + /** + * 获取客户端推送标识信息 + * 客户端标识信息用于业务服务器下发推送消息时提交给推送服务器的数据，用于说明下发推送消息的接收者（客户端）。 + * 通常需要客户端在第一次运行时获取并提交到业务服务器绑定。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + getClientInfo(): PlusPushClientInfo; + /** + * 异步获取客户端推送标识信息 + * HBuilderX2.5.11+版本新增。 + * 用于解决plus.push.getClientInfo同步获取可能返回数据为空的问题。 + * 客户端标识信息用于业务服务器下发推送消息时提交给推送服务器的数据，用于说明下发推送消息的接收者（客户端）。 + * 通常需要客户端在第一次运行时获取并提交到业务服务器绑定。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + getClientInfoAsync(successCB: (result: PlusPushClientInfo) => void, errorCB: (result: any) => void): void; + /** + * 设置程序是否将消息显示在系统消息中心 + * 默认情况下程序在接收到推送消息后将会在系统消息中心显示，通过此方法可关闭默认行为，接收到推送消息后不在系统消息中心显示，通过addEventListener方法的“receive”事件监听处理接收到的消息。 + * 在这种模式下可通过createMessage方法创建在系统消息中心显示的消息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + setAutoNotification(notify: boolean): void; + /** + * 删除推送消息 + * 删除系统消息中心指定的推送消息，可通过getAllMessage方法获取所有的消息后进行操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + remove(message: PlusPushPushMessage): void; +} + +/** + * JSON对象，获取的客户端标识信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ +interface PlusPushClientInfo { + /** + * 推送通道标识 + * 目前支持以下推送通道： + * "igexin" - 表示个推推送； + * "mipush" - 表示小米推送； + * "unipush" - 表示DCloud UniPush。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + id?: string; + /** + * 设备令牌（iOS设备唯一标识），用于APNS服务推送中标识设备的身份 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + token?: string; + /** + * 推送服务令牌（设备唯一标识），用于标识推送信息接收者身份 + * 第三方推送服务器管理的设备唯一标识，在iOS平台此值通常与token不同；在其它平台此值通常与token值一致。 + * 此值与设备及应用都相关，即不同的apk/ipa安装到同一台设备上的值都不相同。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + clientid?: string; + /** + * 第三方推送服务的应用标识 + * 第三方推送服务器管理的应用标识，通常需要在第三方推送服务器平台进行注册获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + appid?: string; + /** + * 第三方推送服务器的应用键值 + * 第三方推送服务器管理的应用键值，通常需要在第三方推送服务器平台进行注册获取。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + appkey?: string; +} + +/** + * JSON对象，推送消息对象 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ +interface PlusPushPushMessage { + /** + * 推送消息显示的标题 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + title?: string; + /** + * 推送消息显示的内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + content?: string; + /** + * 推送消息承载的数据 + * 如果推送消息中传输的数据不符合JSON格式，则作为String类型数据保存。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + payload?: any; + /** + * Apple APNS推送协议数据 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + aps?: any; +} + +/** + * JSON对象，获客户端创建本地消息的参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ +interface PlusPushMessageOptions { + /** + * 要启动流应用的appid + * 仅在流应用环境中有效，默认值为当前流应用的appid。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + appid?: string; + /** + * 是否覆盖上一次提示的消息 + * 可取值true或false，true为覆盖，false不覆盖。 + * 默认为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + cover?: boolean; + /** + * 提示消息延迟显示的时间 + * 当设备接收到推送消息后，可不立即显示，而是延迟一段时间显示，延迟时间单位为s，默认为0s，立即显示。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + delay?: number; + /** + * 推送消息的图标 + * 本地图片地址，相对路径 - 相对于当前页面的host位置，如"a.jpg"，注意当前页面为网络地址则不支持； 绝对路径 - 系统绝对路径，如Android平台"/sdcard/logo.png"，此类路径通常通过其它5+ API获取的； 扩展相对路径URL(RelativeURL) - 以"_"开头的相对路径，如"_www/a.jpg"； 本地路径URL - 以“file://”开头，后面跟随系统绝对路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + icon?: string; + /** + * 推送消息的提示音 + * 显示消息时的播放的提示音，可取值： + * “system”-表示使用系统通知提示音； + * “none”-表示不使用提示音； + * 默认值为“system”。 + * - system: 使用系统通知提示音 + * - none: 不使用提示音 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + sound?: 'system' | 'none'; + /** + * 推送消息的标题 + * 在系统消息中心显示的通知消息标题，默认值为程序的名称。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + title?: string; + /** + * 推送消息的副标题 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + subtitle?: string; + /** + * 消息上显示的提示时间 + * 默认为当前时间，如果延迟显示则使用延时后显示消息的时间。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/push.html](http://www.html5plus.org/doc/zh_cn/push.html) + */ + when?: Date; +} + +/** + * Share模块管理客户端的社交分享功能，提供调用终端社交软件的分享能力。通过plus.share可获取社交分享管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShare { + /** + * JSON对象，分享授权认证参数选项 + * 此对象支持的属性值由分享服务的授权认证模块定义。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + AuthOptions?: PlusShareAuthOptions; + /** + * JSON对象，位置信息（将废弃） + * GeoPosition对象保存位置信息，用于标识分享操作时用户的位置信息。 + * 注意：目前主流App不再支持设置位置信息，将废弃。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + GeoPosition?: PlusShareGeoPosition; + /** + * 分享服务对象 + * ShareService对象用于表示分享服务，在JS中为对象，用于向系统请求分享操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + ShareService?: PlusShareShareService; + /** + * 分享服务标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + ShareServerIdentity?: PlusShareShareServerIdentity; + /** + * JSON对象，分享消息对象 + * ShareMessage对象用于表示分享消息内容，在JS中为JSON对象，用于向系统发送分享信息操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + ShareMessage?: PlusShareShareMessage; + /** + * JSON对象，保存分享消息扩展信息 + * ShareMessageExtra对象用于保存各分享平台扩展的参数，用于自定义分享功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + ShareMessageExtra?: PlusShareShareMessageExtra; + /** + * JSON对象，微信小程序信息 + * 用于配置分享小程序的参数，如小程序标识、页面路径等。 + * 注意：分享的小程序需要在微信开放平台关联的开发者账号下，否则会分享失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + WeixinMiniProgramOptions?: PlusShareWeixinMiniProgramOptions; + /** + * 获取分享服务 + * 获取终端支持的分享通道列表，可用于提示用户进行分享列表选择。 + * 成功后通过successCB回调返回当前环境支持的分享服务列表，失败则通过errorCB回调返回错误信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + getServices(successCB: (result: PlusShareShareService []) => void, errorCB?: (result: any) => void): void; + /** + * 使用系统分享 + * 调用系统分享组件发送分享消息，msg参数中设置分享的内容。 + * 分享成功后通过successCB回调函数通知操作完成，失败则通过errorCB回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + sendWithSystem(msg: PlusShareShareMessage, successCB: () => void, errorCB?: (result: any) => void): void; +} + +/** + * JSON对象，分享授权认证参数选项 + * 此对象支持的属性值由分享服务的授权认证模块定义。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareAuthOptions { + /** + * 分享服务平台申请的appid + * 动态设置分享服务授权认证时需要使用的appid，仅需要此参数的分享服务（如“微信”、“QQ”）支持。 + * 如果未设置则使用运行环境中内置的appid值（如在HBuilder中可在manifest.json的“SDK配置”项中进行设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + appid?: string; + /** + * 分享服务平台申请的appkey + * 动态设置分享服务授权认证时需要使用的appkey，仅需要此参数的分享服务（如“新浪微博”）支持。 + * 如果未设置则使用运行环境中内置的appkey值（如在HBuilder中可在manifest.json的“SDK配置”项中进行设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + appkey?: string; + /** + * 分享服务平台申请的appsecret + * 动态设置分享服务中需要使用的appsecret，仅需要此参数的分享服务（如“微信”、“新浪微博”）支持。 + * 如果未设置则使用运行环境中内置的appsecret值（如在HBuilder中可在manifest.json的“SDK配置”项中进行设置）；当开放平台申请的appsecret值涉及到安全问题时，可在应用运行时从服务器获取，然后通过此api动态设置。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + appsecret?: string; + /** + * 分享服务平台申请的redirect_url + * 动态设置分享服务中需要使用的redirect_url，仅需要此参数的登录授权服务（如“新浪微博登录”）支持。 + * 如果未设置则使用运行环境中内置的redirect_url值（如在HBuilder中可在manifest.json的SDK配置项中进行设置）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + redirect_url?: string; +} + +/** + * JSON对象，位置信息（将废弃） + * GeoPosition对象保存位置信息，用于标识分享操作时用户的位置信息。 + * 注意：目前主流App不再支持设置位置信息，将废弃。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareGeoPosition { + /** + * 用户位置的纬度坐标信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + latitude?: number; + /** + * 用户位置的经度坐标信息 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + longitude?: number; +} + +/** + * 分享服务对象 + * ShareService对象用于表示分享服务，在JS中为对象，用于向系统请求分享操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareShareService { + /** + * 分享服务标识 + * 用于表示分享服务标识： + * "sinaweibo" - 表示新浪微博； + * "weixin" - 表示微信； + * "qq" - 表示腾讯QQ； + * "tencentweibo" - 表示腾讯微博（已废弃）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + id?: PlusShareShareServerIdentity; + /** + * 分享服务描述 + * 用于描述分享服务的信息： + * 如“新浪微博”、“腾讯微博”、“微信”、“QQ”。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + description?: string; + /** + * 是否授权认证 + * 用于标识此分享是否已经授权认证过，true表示已完成授权认证；false表示未完成授权认证。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + authenticated?: boolean; + /** + * 授权认证信息 + * 仅在authenticated为true时有效，标识客户认证标识信息，用于发送分享信息。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + accessToken?: string; + /** + * 是否存在对应的分享客户端 + *

+ * 对于某些分享服务，必须依赖相应客户端App才能实现分享操作；有些分享服务则不依赖，客户端App不存在时调用WAP页面进行分享操作。 + * 具体情况如下： + *

    + *
  • 微信 - 依赖微信客户端App
    • + *
  • QQ - 依赖QQ客户端App
    • + *
  • 新浪微博 - 不依赖微博客户端App
    • + *
+ * 注意：提交AppStore审核时没有安装相应的客户端App可能导致无法通过审核，此时需要判断相应的客户端App是否安装，如果没有安装则不显示对应的分享入口。 + *

+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + nativeClient?: boolean; + /** + * 授权认证操作 + * 对指定的分享服务进行授权认证操作，在授权前可通过ShareService.authenticated属性判断是否已经授权过，通常只需要对没有进行过授权认证的服务进行授权认证操作。 + * 授权认证操作成功后通过successCB回调函数通知操作完成，操作失败则通过errorCB回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + authorize(successCallback: (result: PlusShareShareService) => void, errorCallback?: (result: any) => void, options?: PlusShareAuthOptions): void; + /** + * 取消授权认证 + * 对指定的分享服务取消授权认证操作，取消授权认证后，再次分享时需重新进行授权操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + forbid(): void; + /** + * 发送分享 + * 发送分享消息，分享消息的内容通过msg设置。 + * 发送成功后通过successCB回调函数通知操作完成，发送失败则通过errorCB回调返回。若分享服务没有进行授权认证或授权认证失效则触发失败回调函数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + send(msg: PlusShareShareMessage, successCB: () => void, errorCB?: (result: any) => void): void; + /** + * 调用微信小程序 + * 在微信小程序中打开APP（使用button组件的open-type属性值设置为"launchApp"）时，可通过plus.runtime.arguments获取小程序传入的参数（小程序中button组件的app-parameter属性值）。 + * 注意：需在微信开放平台将应用关联小程序才能正常调用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + launchMiniProgram(options: PlusShareWeixinMiniProgramOptions): void; +} + +/** + * 分享服务标识 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareShareServerIdentity { + /** + * 新浪微博 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + sinaweibo?: string; + /** + * 腾讯微博 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + tencentweibo?: string; + /** + * 微信 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + weixin?: string; +} + +/** + * JSON对象，分享消息对象 + * ShareMessage对象用于表示分享消息内容，在JS中为JSON对象，用于向系统发送分享信息操作。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareShareMessage { + /** + * 分享消息的类型 + *
+ * 微信分享平台，可取值： + *
    + *
  • + * "web"-分享网页类型，title（必填）、content（必填）、thumbs（必填）、href（网页url，必填）属性值有效； + *
    • + *
  • + * "text"-分享文字类型，content（必填）属性值有效； + *
    • + *
  • + * "image"-分享图片类型，pictures（必填）属性值有效； + *
    • + *
  • + * "music"-分享音乐类型，title（必填）、content（必填）、thumbs（必填）、href(网页url，可选)、media（音乐url，必填）属性值有效； + * HBuilderX3.1.0+支持href属性，href为音乐网页地址，media为音乐资源地址。 + *
    • + *
  • + * "video"-分享视频类型，title（必填）、content（必填）、thumbs（必填）、media（视频url，必填）属性值有效； + *
    • + *
  • + * "miniProgram"-分享小程序类型（仅支持分享到好友），title（必填）、content（必填）、thumbs（图片小于128K，宽高比为5:4，必填）、miniProgram（小程序参数，必填）属性值有效； + *
    • + *
+ * 没有设置type时，如果href值有效则默认值为"web"，如果pictures有效则默认值为"image"，否则默认值为"text"。 + * 新浪微博分享平台，可取值： + *
    + *
  • + * "web"-分享网页类型，content、href（网页url，必填），分享链接添加到内容之后； + *
    • + *
  • + * "text"-分享文字类型，content（必填）属性有效，可在内容中直接插入链接地址； + *
    • + *
  • + * "image"-分享图片类型，content（可选）、thumbs（可选）、pictures（必填）属性有效； + *
    • + *
  • + * "video"-分享视频类型，content（可选）、thumbs（可选）、media（本地视频文件，必填）属性有效； + *
    • + *
+ * 没有设置type时，如果存在thumbs则默认值为"image"，如果存在href则默认值为"web"，否则默认为"text"。 + * QQ分享平台，可取值： + *
    + *
  • + * "web"-分享网页类型，title（必填）、content（必填）、thumbs（必填）、href（网页url，必填）属性值有效； + * 注意：HBuilderX2.9.9+版本支持。 + * Android平台在低版本QQ上可能不支持图片（thumbs），需更新到最新版本QQ。 + *
    • + *
  • + * "text"-分享文字类型，href（iOS可选，Android必填）、title（必填，最长30个字符）、content（可选，最长40个字符）、pictures或thumbs（可选，优先pictures，iOS不支持）属性有效； + *
    • + *
  • + * "image"-分享图片类型，pictures或thumbs（必填，优先pictures）属性有效； + *
    • + *
  • + * "music"-分享音乐类型，title（必填，最长30个字符）、content（可选，最长40个字符）、href（网页url，必填）、media（音乐url，必填）、pictures或thumbs（可选，优先pictures）属性值有效； + *
    • + *
+ * 没有设置type时，默认值"text"。 + *
+ * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + type?: string; + /** + * 分享消息的文字内容 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + content?: string; + /** + * 分享消息的图片 + * 分享消息中包含的图片路径，仅支持本地路径。 + * 若分享平台仅支持提交一张图片，传入多张图片则仅提交第一张图片。 + * 如果未指定type类型，优先级顺序为：pictures>content（即设置了pictures则认为分享图片类型）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + pictures?: string []; + /** + * 分享消息的缩略图 + * 分享消息中包含的缩略图路径，支持本地路径及网络路径。 + * 若分享平台仅支持提交一张图片，传入多张图片则仅提交第一张图片。 + * 如果分享平台的信息不支持缩略图，若没有设置消息的图片（pictures）则使用缩略图，否则忽略其属性值。 + * 注意：图片有大小限制，推荐图片小于20Kb。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + thumbs?: string []; + /** + * 分享的多媒体资源 + * 分享的多媒体资源地址，当type值为"music"、"video"时有效。 + * 注意： + * 微信分享平台支持音乐、视频类型，仅支持网络地址（以http://或https://开头）； + * QQ分享平台支持音乐类型，仅支持网络路径（以http://或https://开头）； + * 新浪微博分享平台支持视频类型，仅支持本地文件路径。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + media?: string; + /** + * 分享独立的链接 + * 分享资源地址，仅支持网络地址（以http://或https://开头）。 + * 如果未指定type类型，优先级顺序为：href>pictures>content（即设置了href则认为分享网页类型）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + href?: string; + /** + * 分享消息的标题 + * 仅微信分享网页、音频、视频、小程序类型时支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + title?: string; + /** + * 分享消息中包含位置信息（将废弃） + * 注意：目前主流App不再支持设置位置信息，将废弃。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + geo?: PlusShareGeoPosition; + /** + * 分享消息扩展参数 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + extra?: PlusShareShareMessageExtra; + /** + * 分享微信小程序参数 + * 仅微信分享小程序类型时支持。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + miniProgram?: PlusShareWeixinMiniProgramOptions; + /** + * 分享消息的模式 + * 可取值： + * "auto" - 自动选择，如果已经安装微博客户端则采用编辑界面进行分享，否则采用无界面分享； + * "slient" - 静默分享，采用无界面模式进行分享； + * "editable" - 进入编辑界面，用户确认分享内容后发送，如果当前未安装微博客户端则触发错误回调。 + * 默认值为"auto"。 + * （仅新浪微博分享时生效） + * - auto: + * 自动选择，如果已经安装微博客户端则采用编辑界面进行分享，否则采用无界面分享 + * + * - slient: + * 静默分享，采用无界面模式进行分享 + * + * - editable: + * 进入编辑界面，用户确认分享内容后发送，如果当前未安装微博客户端则触发错误回调 + * + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + interface?: 'auto' | 'slient' | 'editable'; +} + +/** + * JSON对象，保存分享消息扩展信息 + * ShareMessageExtra对象用于保存各分享平台扩展的参数，用于自定义分享功能。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareShareMessageExtra { + /** + * 微信分享场景，仅微信分享平台有效 + * 可取值： + * "WXSceneSession"分享到微信的“我的好友”； + * "WXSceneTimeline"分享到微信的“朋友圈”中； + * "WXSceneFavorite"分享到微信的“我的收藏”中。 + * 默认值为"WXSceneSession"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + scene?: string; +} + +/** + * JSON对象，微信小程序信息 + * 用于配置分享小程序的参数，如小程序标识、页面路径等。 + * 注意：分享的小程序需要在微信开放平台关联的开发者账号下，否则会分享失败。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ +interface PlusShareWeixinMiniProgramOptions { + /** + * 微信小程序ID + * 注意：是微信小程序的原始ID（"g_"开头的字符串）。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + id?: string; + /** + * 微信小程序打开的页面路径 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + path?: string; + /** + * 微信小程序版本类型 + * 可取值： + * 0-正式版； + * 1-测试版； + * 2-体验版。 + * 默认值为0。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + type?: number; + /** + * 兼容低版本的网页链接 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/share.html](http://www.html5plus.org/doc/zh_cn/share.html) + */ + webUrl?: string; +} + +/** + * Speech模块管理语音输入功能，提供语音识别功能，可支持用户通过麦克风设备进行语音输入内容。通过plus.speech可获取语音输入管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ +interface PlusSpeech { + /** + * JSON对象，语音识别参数 + * 控制语音识别引擎内部参数，在JS中为JSON对象，在启动语音识别时使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + SpeechRecognizeOptions?: PlusSpeechSpeechRecognizeOptions; + /** + * 语音识别事件类型 + * 描述语音过程的触发事件列表，可以通过调用plus.sppech.addEventListener方法进行注册监听。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + SpeechRecoginzeEvents?: PlusSpeechSpeechRecoginzeEvents; + /** + * 启动语音识别 + * 启动语音识别时调用，当语音识别成功后通过successCallback回调返回识别出文本内容，调用语音识别失败则通过errorCallback回调返回。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + startRecognize(options: PlusSpeechSpeechRecognizeOptions, successCB?: (result: string) => void, errorCB?: (result: any) => void): void; + /** + * 停止语音识别 + * 当语音识别完成时或用户取消语音识别时调用，调用此方法将导致errorCallback回调函数的调用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + stopRecognize(): void; + /** + * 监听语音识别事件 + * 向语音识别模块添加事件监听器，当指定的事件发生时，将触发listener函数的执行。 + * 可多次调用此方法添加多个监听器，当监听的事件发生时，将按照添加的先后顺序触发执行。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + addEventListener(event: 'start' | 'volumeChange' | 'recognizing' | 'recognition' | 'end' | 'error', listener: (result: any) => void, capture?: boolean): void; +} + +/** + * JSON对象，语音识别参数 + * 控制语音识别引擎内部参数，在JS中为JSON对象，在启动语音识别时使用。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ +interface PlusSpeechSpeechRecognizeOptions { + /** + * 语音识别是否采用持续模式 + * 设置为true表示语音引擎不会根据语音输入自动结束，识别到文本内容将多次调用successCallback函数返回，如果需要结束语音识别则必须调用stopRecognize接口，默认值为false。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + continue?: boolean; + /** + * 语音识别引擎标识 + * 用于兼容多语音识别引擎的浏览器，使用语音识别厂商的产品名称，如未设置或设置不正确则使用运行环境默认的语音识别引擎。 + * 支持以下语音识别引擎： + * "baidu"-百度语音识别； + * "iFly"-讯飞语音识别。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + engine?: string; + /** + * 语音识别引擎的语言 + * 用于定义语音识别引擎的语言，其取值需符合W3C的Language codes规范。 + * 目前讯飞语音支持以下语言： + * "zh-cn"-中文，普通话； + * "en-us"-英语； + * "zh-cantonese"-中文，粤语； + * "zh-henanese"-中文，河南话（百度语音识别不支持此语言）。 + * 默认值为"zh-cn"。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + lang?: string; + /** + * 指定识别结果识别包括多候选结果 + * 用于指定识别结果识别包括多候选结果。如nbest:3，识别返回3个候选结果，默认值为1。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + nbest?: number; + /** + * 识别结果中是否包含标点符号 + * true表示识别结果文本中包含标点符号，false表示识别结果文本中不包含标点符号。 + * 默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + punctuation?: boolean; + /** + * 语音识别超时时间 + * 语音识别超时的时间，单位为ms，默认值为1000（即10秒）。 + * 注：百度语音识别不支持此参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + timeout?: number; + /** + * 识别时是否显示用户界面 + * 用于指定识别时是否显示用户界面，设置为true表示显示浏览器内置语音识别界面；设置为false表示不显示浏览器内置语音识别界面。默认值为true。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + userInterface?: boolean; + /** + * 语音识别开始事件（已废弃，使用start事件） + * 事件函数，语音识别开始启动，在调用startRecognize方法后触发，与onend事件成对触发。 + * 注：iOS平台未支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + onstart?: (result: any) => void; + /** + * 语音识别结束事件（已废弃，使用end事件） + * 事件函数，语音识别结束，在调用stopRecognize方法后触发，或者在引擎内部自动完成语音识别后触发，与onstart事件成对触发。 + * 注：iOS平台未支持 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + onend?: (result: any) => void; +} + +/** + * 语音识别事件类型 + * 描述语音过程的触发事件列表，可以通过调用plus.sppech.addEventListener方法进行注册监听。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ +interface PlusSpeechSpeechRecoginzeEvents { + /** + * 开始语音识别 + * 调用plus.speech.startRecognize方法开始语音识别时触发。 + * 无回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + start?: string; + /** + * 音量变化 + * 开始语音识别后，麦克风录制到的语音音量变化时触发。 + * 回调函数参数event={volume:"Number类型，取值范围0-1"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + volumeChange?: string; + /** + * 临时语音识别结果 + * 返回临时语音识别结果时触发。 + * 回调函数参数event={partialResult:"String类型，临时识别结果"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + recognizing?: string; + /** + * 最终语音识别 + * 返回最终语音识别结果。 + * 回调函数参数event={result:"String类型，最佳识别结果",results:"String数组类型，所有候选结果"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + recognition?: string; + /** + * 结束语音识别 + * 调用plus.speech.stopRecognize方法结束语音识别或语音识别完成后自动结束时触发。 + * 无回调函数参数。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + end?: string; + /** + * 语音识别错误 + * 语音识别发生错误时触发。 + * 回调函数参数event={code:"Number类型，错误编码",message:"String类型，错误描述信息"}。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/speech.html](http://www.html5plus.org/doc/zh_cn/speech.html) + */ + error?: string; +} + +/** + * Statistic模块管理统计功能，用于提供应用内统计的能力，支持统计和分析用户属性和用户行为数据。通过plus.statistic可获取统计管理对象。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/statistic.html](http://www.html5plus.org/doc/zh_cn/statistic.html) + */ +interface PlusStatistic { + /** + * 触发事件 + * 触发指定的统计事件，触发的事件必须要先在统计网站上注册事件ID。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/statistic.html](http://www.html5plus.org/doc/zh_cn/statistic.html) + */ + eventTrig(id: string, value?: object | string): void; + /** + * 精确持续事件 + * 精确时长的持续事件统计，触发的事件必须要先在统计网站上注册事件ID。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/statistic.html](http://www.html5plus.org/doc/zh_cn/statistic.html) + */ + eventDuration(id: string, duration: number, value?: object | string): void; + /** + * 开始持续事件（过期API，不推荐使用） + * 开始指定的持续事件统计，当事件结束时调用eventEnd方法，，触发的事件必须要先在统计网站上注册事件ID。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/statistic.html](http://www.html5plus.org/doc/zh_cn/statistic.html) + */ + eventStart(id: string, value?: string): void; + /** + * 结束持续事件（过期API，不推荐使用） + * 结束指定的持续事件统计，需先调用eventStart方法开始持续事件统计，触发的事件必须要先在统计网站上注册事件ID。 + * + * 参考: [http://www.html5plus.org/doc/zh_cn/statistic.html](http://www.html5plus.org/doc/zh_cn/statistic.html) + */ + eventEnd(id: string, label?: string): void; +} diff --git a/resources/mobile/node_modules/@dcloudio/types/index.d.ts b/resources/mobile/node_modules/@dcloudio/types/index.d.ts new file mode 100644 index 0000000..db5358d --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/index.d.ts @@ -0,0 +1,2 @@ +/// +/// \ No newline at end of file diff --git a/resources/mobile/node_modules/@dcloudio/types/package.json b/resources/mobile/node_modules/@dcloudio/types/package.json new file mode 100644 index 0000000..4a7928d --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/package.json @@ -0,0 +1,14 @@ +{ + "name": "@dcloudio/types", + "version": "2.6.12", + "description": "uni-app types", + "typings": "index.d.ts", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "fxy060608", + "license": "Apache-2.0", + "devDependencies": { + "vue": "^2.6.10" + } +} diff --git a/resources/mobile/node_modules/@dcloudio/types/uni-app/app.d.ts b/resources/mobile/node_modules/@dcloudio/types/uni-app/app.d.ts new file mode 100644 index 0000000..d11f945 --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/uni-app/app.d.ts @@ -0,0 +1,201 @@ +declare namespace App { + interface ReferrerInfo { + /** + * 来源小程序或公众号或App的 appId + * + * 以下场景支持返回 referrerInfo.appId： + * - 1020（公众号 profile 页相关小程序列表）： appId + * - 1035（公众号自定义菜单）：来源公众号 appId + * - 1036（App 分享消息卡片）：来源应用 appId + * - 1037（小程序打开小程序）：来源小程序 appId + * - 1038（从另一个小程序返回）：来源小程序 appId + * - 1043（公众号模板消息）：来源公众号 appId + */ + appId: string; + /** + * 来源小程序传过来的数据，scene=1037或1038时支持 + */ + extraData?: any; + } + + interface LaunchShowOption { + /** + * 打开小程序的路径 + */ + path: string; + /** + * 打开小程序的query + */ + query: AnyObject; + /** + * 打开小程序的场景值 + * - 1001: 发现栏小程序主入口，「最近使用」列表（基础库2.2.4版本起包含「我的小程序」列表） + * - 1005: 顶部搜索框的搜索结果页 + * - 1006: 发现栏小程序主入口搜索框的搜索结果页 + * - 1007: 单人聊天会话中的小程序消息卡片 + * - 1008: 群聊会话中的小程序消息卡片 + * - 1011: 扫描二维码 + * - 1012: 长按图片识别二维码 + * - 1013: 手机相册选取二维码 + * - 1014: 小程序模板消息 + * - 1017: 前往体验版的入口页 + * - 1019: 微信钱包 + * - 1020: 公众号 profile 页相关小程序列表 + * - 1022: 聊天顶部置顶小程序入口 + * - 1023: 安卓系统桌面图标 + * - 1024: 小程序 profile 页 + * - 1025: 扫描一维码 + * - 1026: 附近小程序列表 + * - 1027: 顶部搜索框搜索结果页「使用过的小程序」列表 + * - 1028: 我的卡包 + * - 1029: 卡券详情页 + * - 1030: 自动化测试下打开小程序 + * - 1031: 长按图片识别一维码 + * - 1032: 手机相册选取一维码 + * - 1034: 微信支付完成页 + * - 1035: 公众号自定义菜单 + * - 1036: App 分享消息卡片 + * - 1037: 小程序打开小程序 + * - 1038: 从另一个小程序返回 + * - 1039: 摇电视 + * - 1042: 添加好友搜索框的搜索结果页 + * - 1043: 公众号模板消息 + * - 1044: 带 shareTicket 的小程序消息卡片 + * - 1045: 朋友圈广告 + * - 1046: 朋友圈广告详情页 + * - 1047: 扫描小程序码 + * - 1048: 长按图片识别小程序码 + * - 1049: 手机相册选取小程序码 + * - 1052: 卡券的适用门店列表 + * - 1053: 搜一搜的结果页 + * - 1054: 顶部搜索框小程序快捷入口 + * - 1056: 音乐播放器菜单 + * - 1057: 钱包中的银行卡详情页 + * - 1058: 公众号文章 + * - 1059: 体验版小程序绑定邀请页 + * - 1064: 微信连Wi-Fi状态栏 + * - 1067: 公众号文章广告 + * - 1068: 附近小程序列表广告 + * - 1069: 移动应用 + * - 1071: 钱包中的银行卡列表页 + * - 1072: 二维码收款页面 + * - 1073: 客服消息列表下发的小程序消息卡片 + * - 1074: 公众号会话下发的小程序消息卡片 + * - 1077: 摇周边 + * - 1078: 连Wi-Fi成功页 + * - 1079: 微信游戏中心 + * - 1081: 客服消息下发的文字链 + * - 1082: 公众号会话下发的文字链 + * - 1084: 朋友圈广告原生页 + * - 1089: 微信聊天主界面下拉，「最近使用」栏（基础库2.2.4版本起包含「我的小程序」栏） + * - 1090: 长按小程序右上角菜单唤出最近使用历史 + * - 1091: 公众号文章商品卡片 + * - 1092: 城市服务入口 + * - 1095: 小程序广告组件 + * - 1096: 聊天记录 + * - 1097: 微信支付签约页 + * - 1099: 页面内嵌插件 + * - 1102: 公众号 profile 页服务预览 + * - 1103: 发现栏小程序主入口，「我的小程序」列表（基础库2.2.4版本起废弃） + * - 1104: 微信聊天主界面下拉，「我的小程序」栏（基础库2.2.4版本起废弃） + */ + scene: number; + /** + * 打开小程序的场景值 + */ + shareTicket: string; + /** + * 当场景为由从另一个小程序或公众号或App打开时，返回此字段 + */ + referrerInfo?: ReferrerInfo; + } + + interface PageNotFoundOption { + /** + * 不存在页面的路径 + */ + path: string; + /** + * 打开不存在页面的 query + */ + query: AnyObject; + /** + * 是否本次启动的首个页面（例如从分享等入口进来，首个页面是开发者配置的分享页面） + */ + isEntryPage: boolean; + } + + interface AppInstance { + /** + * 全局对象 + */ + globalData?: AnyObject; + /** + * 生命周期回调 监听应用初始化 + * + * 应用初始化完成时触发，全局只触发一次。 + */ + onLaunch?(options?: LaunchShowOption): void; + /** + * 生命周期回调 监听应用显示 + * + * 应用启动，或从后台进入前台显示时触发 + */ + onShow?(options?: LaunchShowOption): void; + /** + * 生命周期回调 监听应用隐藏 + * + * 应用从前台进入后台时触发 + */ + onHide?(): void; + /** + * 错误监听函数 + * 小程序发生脚本错误或 API 调用报错时触发 + * @param error 错误信息，包含堆栈 + */ + onError?(error: string): void; + /** + * 页面不存在监听函数 + * + * 应用要打开的页面不存在时触发，会带上页面信息回调该函数 + * + * **注意：** + * 1. 如果开发者没有添加 `onPageNotFound` 监听，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。 + * 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再回调 `onPageNotFound`。 + */ + onPageNotFound?(options: PageNotFoundOption): void; + /** + * 未处理的 Promise 拒绝事件监听函数 + */ + onUnhandledRejection?(options: UniApp.OnUnhandledRejectionCallbackResult): void; + /** + * 监听系统主题变化 + */ + onThemeChange?(options: UniApp.OnThemeChangeCallbackResult): void; + /** + * 监听 nvue 页面消息 + * + * nvue 页面使用 `uni.postMessage` 发送消息时触发 + */ + onUniNViewMessage?(options: AnyObject): void; + } + + type AppConstructor = ( + options: AppInstance & T, + ) => void; + + interface GetAppOption { + /** + * 在 `App` 未定义时返回默认实现。当App被调用时，默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包 + */ + allowDefault: boolean; + } + + type GetApp = (opts?: GetAppOption) => AppInstance & T; +} + +declare const getApp: App.GetApp; + +declare const createApp: any; +declare const createPage: any; +declare const createComponent: any; diff --git a/resources/mobile/node_modules/@dcloudio/types/uni-app/cloud.d.ts b/resources/mobile/node_modules/@dcloudio/types/uni-app/cloud.d.ts new file mode 100644 index 0000000..c2ed352 --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/uni-app/cloud.d.ts @@ -0,0 +1,3097 @@ +declare namespace UniCloudClientNamespace { + + enum UPDATE_COMMANDS_LITERAL { + SET = 'set', + REMOVE = 'remove', + INC = 'inc', + MUL = 'mul', + PUSH = 'push', + PULL = 'pull', + PULL_ALL = 'pullAll', + POP = 'pop', + SHIFT = 'shift', + UNSHIFT = 'unshift', + ADD_TO_SET = 'addToSet', + BIT = 'bit', + RENAME = 'rename', + MAX = 'max', + MIN = 'min' + } + + enum QUERY_COMMANDS_LITERAL { + EQ = 'eq', + NEQ = 'neq', + GT = 'gt', + GTE = 'gte', + LT = 'lt', + LTE = 'lte', + IN = 'in', + NIN = 'nin', + ALL = 'all', + ELEM_MATCH = 'elemMatch', + EXISTS = 'exists', + SIZE = 'size', + MOD = 'mod', + GEO_NEAR = 'geoNear', + GEO_WITHIN = 'geoWithin', + GEO_INTERSECTS = 'geoIntersects' + } + + enum LOGIC_COMMANDS_LITERAL { + AND = 'and', + OR = 'or', + NOT = 'not', + NOR = 'nor' + } + + interface InternalSymbol { + for(target: any): InternalSymbol; + } + + interface LogicCommand { + fieldName: any; + operator: any; + operands: any; + _internalType: InternalSymbol; + _setFieldName(fieldName: string): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=and](http://uniapp.dcloud.io/uniCloud/cf-database?id=and) + */ + and(__expressions__: any): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件。或指令有两种用法，一是可以进行字段值的 “或” 操作，二是也可以进行跨字段的 “或” 操作。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=or](http://uniapp.dcloud.io/uniCloud/cf-database?id=or) + */ + or(__expressions__: any): LogicCommand; + } + type GetTempQuery = unknown + + /** + * 时区，'Asia/Shanghai' 或 '+08:00' 格式均支持 + */ + type Timezone = string + + interface DateToStringOptions { + /** + * 日期表达式 + */ + date: string; + /** + * 格式化表达式 + */ + format: string; + /** + * 时区表达式，指明运算结果的时区。它可以解析格式为 UTC Offset 或者 Olson Timezone Identifier 的字符串。 + * - Asia/Shanghai: + */ + timezone?: Timezone; + /** + * 空值表达式，可选。当日期表达式返回空或者不存在的时候，会返回此表达式指明的值。 + */ + onNull?: string; + } + + interface DateFromStringOptions { + /** + * 日期字符串 + */ + dateString: string; + /** + * 时区，Olson Timezone Identifier + * - Asia/Shanghai: + */ + timezone?: Timezone; + } + + interface DateFromPartsOptions { + /** + * 年份 + */ + year?: number; + /** + * 月份 + */ + month?: number; + /** + * 日期 + */ + day?: number; + /** + * 小时 + */ + hour?: number; + /** + * 分钟 + */ + minute?: number; + /** + * 秒 + */ + second?: number; + /** + * 毫秒 + */ + millisecond?: number; + /** + * 时区，Olson Timezone Identifier + * - Asia/Shanghai: + */ + timezone?: Timezone; + /** + * ISO标准年份 + */ + isoWeekYear?: number; + /** + * ISO标准一年中的第几周 + */ + isoWeek?: number; + /** + * ISO标准一周中的第几天（周一：0-周日：7） + */ + isoDayOfWeek?: number; + } + + type DBDate = unknown + + interface ZipOptions { + /** + * 一个二维数组（inputs 不可以是字段引用），其中每个元素的表达式（这个可以是字段引用）都可以解析为数组。如果其中任意一个表达式返回 null，inputs 也返回 + * null。如果其中任意一个表达式不是指向一个合法的字段 / 解析为数组 / 解析为 null，则返回错误。 + */ + inputs: any; + /** + * 决定输出数组的长度是否采用输入数组中的最长数组的长度。默认为 false，即输入数组中的最短的数组的长度即是输出数组的各个元素的长度。 + */ + useLongestLength: any; + /** + * 一个数组，用于指定在输入数组长度不一的情况下时采用的数组各元素默认值。指定这个字段则必须指定 useLongestLength，否则返回错误。如果 useLongestLength + * 是 true 但是 + * defaults 是空或没有指定，则 zip 用 null 做数组元素的缺省默认值。指定各元素默认值时 defaults 数组的长度必须是输入数组最大的长度。 + */ + defaults: any; + } + + interface ReduceOptions { + /** + * 输入数组，可以是任意解析为数组的表达式 + */ + input: string | any[]; + /** + * 初始值 + */ + initialValue: string; + /** + * 用来作用于每个元素的表达式，在 in 中有两个可用变量，value 是表示累计值的变量，this 是表示当前数组元素的变量 + */ + in: any; + } + + interface MapOptions { + /** + * 一个可以解析为数组的表达式 + */ + input: string; + /** + * 可选，用于表示数组各个元素的变量，默认为 this + */ + as: string; + /** + * 一个可以应用在给定数组的各个元素上的表达式，各个元素的名字由 as 参数决定（参数名需加 $$ 前缀，如 $$this） + */ + in: any; + } + + interface FilterOptions { + /** + * 一个可以解析为数组的表达式 + */ + input: string; + /** + * 可选，用于表示数组各个元素的变量，默认为 this + */ + as: string; + /** + * 一个可以解析为布尔值的表达式，用于判断各个元素是否满足条件，各个元素的名字由 as 参数决定（参数名需加 $$ 前缀，如 $$this） + */ + cond: boolean; + } + + interface BranchedOptions { + /** + * 判断条件 + */ + case: any; + /** + * 条件为真时执行的操作 + */ + then: any; + } + + interface LetOptions { + /** + * 定义多个变量，变量的值由 变量表达式 计算而来，并且被定义的变量只有在 in 中的 结果表达式 才可以访问。 + */ + vars: any; + /** + * 结果表达式中访问自定义变量时候，请在变量名前加上双美元符号( $$ )并用引号括起来，如：'$$price' + */ + in: any; + } + + interface SwitchOptions { + /** + * switch操作的分支部分 + */ + branches: BranchedOptions[]; + /** + * switch的默认操作 + */ + default: any; + } + + interface BucketOptions { + /** + * 一个用以决定分组的表达式，会应用在各个输入记录上。可以用 $ 前缀加上要用以分组的字段路径来作为表达式。除非用 default + * 指定了默认值，否则每个记录都需要包含指定的字段，且字段值必须在 + * boundaries 指定的范围之内。 + */ + groupBy: string; + /** + * 一个数组，每个元素分别是每组的下界。必须至少指定两个边界值。数组值必须是同类型递增的值 + */ + boundaries: any[]; + /** + * 可选，指定之后，没有进入任何分组的记录将都进入一个默认分组，这个分组记录的 _id 即由 default 决定。default 的值必须小于 boundaries + * 中的最小值或大于等于其中的最大值。default 的值可以与 boundaries 元素值类型不同。 + */ + default: string; + /** + * 可选，用以决定输出记录除了 _id 外还要包含哪些字段，各个字段的值必须用累加器表达式指定。 + */ + output: any; + } + + interface BucketAutoOptions { + /** + * 一个用以决定分组的表达式，会应用在各个输入记录上。可以用 $ 前缀加上要用以分组的字段路径来作为表达式。除非用 default + * 指定了默认值，否则每个记录都需要包含指定的字段，且字段值必须在 + * boundaries 指定的范围之内。 + */ + groupBy: string; + /** + * 一个用于指定划分组数的正整数 + */ + buckets: number; + /** + * 用于保证自动计算出的边界符合给定的规则。这个字段仅可在所有 groupBy 值都是数字并且没有 NaN 的情况下使用。 + * - R5: 边界规则 + * - R10: 边界规则 + * - R20: 边界规则 + * - R40: 边界规则 + * - R80: 边界规则 + * - 1-2-5: 边界规则 + * - E6: 边界规则 + * - E12: 边界规则 + * - E24: 边界规则 + * - E48: 边界规则 + * - E96: 边界规则 + * - E192: 边界规则 + * - POWERSOF: 边界规则 + */ + granularity: 'R5' | 'R10' | 'R20' | 'R40' | 'R80' | '1-2-5' | 'E6' | 'E12' | 'E24' | 'E48' | 'E96' | 'E192' | 'POWERSOF'; + /** + * 用以决定输出记录除了 _id 外还要包含哪些字段，各个字段的值必须用累加器表达式指定 + */ + output: any; + } + + interface LookupOptions { + /** + * 要进行连接的另外一个集合的名字 + */ + from: string; + /** + * 当前流水线的输入记录的字段名，该字段将被用于与 from 指定的集合的 foreignField 进行相等匹配。如果输入记录中没有该字段，则该字段的值在匹配时会被视作 null + */ + localField: string; + /** + * 被连接集合的字段名，该字段会被用于与 localField 进行相等匹配。如果被连接集合的记录中没有该字段，该字段的值将在匹配时被视作 null + */ + foreignField: string; + /** + * 指定连接匹配出的记录列表要存放的字段名，这个数组包含的是匹配出的来自 from 集合的记录。如果输入记录中本来就已有该字段，则该字段会被覆写 + */ + as: string; + } + + interface LookupPipelineOptions { + /** + * 要进行连接的另外一个集合的名字 + */ + from: string; + /** + * 可选。指定在 pipeline 中可以使用的变量，变量的值可以引用输入记录的字段，比如 let: { userName: '$name' } 就代表将输入记录的 name + * 字段作为变量 userName + * 的值。在 pipeline 中无法直接访问输入记录的字段，必须通过 let 定义之后才能访问，访问的方式是在 expr 操作符中用 $$变量名 的方式访问，比如 $$userName。 + */ + let: any; + /** + * 指定要在被连接集合中运行的聚合操作。如果要返回整个集合，则该字段取值空数组 []。在 pipeline 中无法直接访问输入记录的字段，必须通过 let + * 定义之后才能访问，访问的方式是在 expr + * 操作符中用 $$变量名 的方式访问，比如 $$userName。 + */ + pipeline: any; + /** + * 指定连接匹配出的记录列表要存放的字段名，这个数组包含的是匹配出的来自 from 集合的记录。如果输入记录中本来就已有该字段，则该字段会被覆写 + */ + as: string; + } + + interface ISerializedLineString { + type: string; + coordinates: any; + } + + interface ISerializedPolygon { + type: string; + coordinates: any; + } + + interface ISerializedMultiPoint { + type: string; + coordinates: any; + } + + interface ISerializedMultiLineString { + type: string; + coordinates: any; + } + + interface ISerializedMultiPolygon { + type: string; + coordinates: any; + } + + interface UnwindOptions { + /** + * 想要拆分的数组的字段名，需要以 $ 开头。 + */ + path: string; + /** + * 传入一个新的字段名，数组索引会保存在这个新的字段上。新的字段名不能以 $ 开头。 + */ + includeArrayIndex: string; + /** + * 如果为 true，那么在 path 对应的字段为 null、空数组或者这个字段不存在时，依然会输出这个文档；如果为 false，unwind 将不会输出这些文档。默认为 false。 + */ + preserveNullAndEmptyArrays: boolean; + } + + interface SampleOptions { + /** + * 返回记录的数量 + */ + size: number; + } + + interface ReplaceRootOptions { + /** + * 新的根节点 + */ + newRoot: any; + } + + interface GetTreeParam { + /** + * 第一层级条件 + */ + startWith: string; + /** + * 最大查询层级 + */ + limitLevel: number; + } + + interface GetTreePathParam { + /** + * 要查询节点的条件 + */ + startWith: string; + /** + * 最大查询层级 + */ + limitLevel: number; + } + + interface GetParam { + /** + * 是否获取单条 + */ + getOne?: boolean; + /** + * 是否返回总数 + */ + getCount?: boolean; + /** + * 查询树形结构选定节点的所有子节点 + */ + getTree?: GetTreeParam | boolean; + /** + * 查询选定节点在树形结构内的路径 + */ + getTreePath?: GetTreePathParam; + } + + interface AggregateCommand { + /** + * 返回一个数字的绝对值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=abs](http://uniapp.dcloud.io/uniCloud/cf-database?id=abs) + */ + abs(absOptions: number | string): number; + /** + * 将数字相加或将数字加在日期上。如果数组中的其中一个值是日期，那么其他值将被视为毫秒数加在该日期上。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=add](http://uniapp.dcloud.io/uniCloud/cf-database?id=add) + */ + add(addOptions: any[]): number; + /** + * 向上取整，返回大于或等于给定数字的最小整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=ceil](http://uniapp.dcloud.io/uniCloud/cf-database?id=ceil) + */ + ceil(ceilOptions: number | string): number; + /** + * 传入被除数和除数，求商。参数形式为：[被除数,除数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=divide](http://uniapp.dcloud.io/uniCloud/cf-database?id=divide) + */ + divide(divideOptions: any[]): number; + /** + * 取 e（自然对数的底数，欧拉数） 的 n 次方 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=exp](http://uniapp.dcloud.io/uniCloud/cf-database?id=exp) + */ + exp(expOptions: number | string): number; + /** + * 向下取整，返回大于或等于给定数字的最小整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=floor](http://uniapp.dcloud.io/uniCloud/cf-database?id=floor) + */ + floor(floorOptions: number | string): number; + /** + * 计算给定数字在自然对数值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=ln](http://uniapp.dcloud.io/uniCloud/cf-database?id=ln) + */ + ln(lnOptions: number | string): number; + /** + * 计算给定数字在给定对数底下的 log 值。参数形式为：[真数,底数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=log](http://uniapp.dcloud.io/uniCloud/cf-database?id=log) + */ + log(logOptions: any[]): number; + /** + * 计算给定数字在对数底为 10 下的 log 值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=log10](http://uniapp.dcloud.io/uniCloud/cf-database?id=log10) + */ + log10(log10Options: number | string): number; + /** + * 取模运算，取数字取模后的值。参数形式为：[被除数,除数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=mod](http://uniapp.dcloud.io/uniCloud/cf-database?id=mod) + */ + mod(modOptions: any[]): number; + /** + * 取传入的数字参数相乘的结果。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=multiply](http://uniapp.dcloud.io/uniCloud/cf-database?id=multiply) + */ + multiply(multiplyOptions: any[]): number; + /** + * 求给定基数的指数次幂。参数形式为：[底数,指数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=pow](http://uniapp.dcloud.io/uniCloud/cf-database?id=pow) + */ + pow(powOptions: any[]): number; + /** + * 求平方根。参数形式为：[被开方数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=sqrt](http://uniapp.dcloud.io/uniCloud/cf-database?id=sqrt) + */ + sqrt(sqrtOptions: any[]): number; + /** + * 将两个数字相减然后返回差值，或将两个日期相减然后返回相差的毫秒数，或将一个日期减去一个数字返回结果的日期。参数形式为：[被减数,减数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=subtract](http://uniapp.dcloud.io/uniCloud/cf-database?id=subtract) + */ + subtract(subtractOptions: any[]): number; + /** + * 将数字截断为整形。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=trunc](http://uniapp.dcloud.io/uniCloud/cf-database?id=trunc) + */ + trunc(truncOptions: number | string): number; + /** + * 返回在指定数组下标的元素。参数形式为：[数组,下标] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=arrayelemat](http://uniapp.dcloud.io/uniCloud/cf-database?id=arrayelemat) + */ + arrayElemAt(arrayElemAtOptions: any[]): any; + /** + * 将一个数组转换为对象。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=arraytoobject](http://uniapp.dcloud.io/uniCloud/cf-database?id=arraytoobject) + */ + arrayToObject(arrayToObjectOptions: any[] | string): any; + /** + * 将多个数组拼接成一个数组。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=concatarrays](http://uniapp.dcloud.io/uniCloud/cf-database?id=concatarrays) + */ + concatArrays(concatArraysOptions: any[]): any[]; + /** + * 根据给定条件返回满足条件的数组的子集。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=filter](http://uniapp.dcloud.io/uniCloud/cf-database?id=filter) + */ + filter(filterOptions: FilterOptions): any[]; + /** + * 给定一个值和一个数组，如果值在数组中则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=in](http://uniapp.dcloud.io/uniCloud/cf-database?id=in) + */ + in(inOptions: number | string): number; + /** + * 在数组中找出等于给定值的第一个元素的下标，如果找不到则返回 -1。参数形式为：[数组,查找值,起始索引,结束索引]，起始索引、结束索引为可选值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofarray](http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofarray) + */ + indexOfArray(indexOfArrayOptions: any[]): number; + /** + * 判断给定表达式是否是数组，返回布尔值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isarray](http://uniapp.dcloud.io/uniCloud/cf-database?id=isarray) + */ + isArray(isArrayOptions: any[]): boolean; + /** + * 类似 JavaScript Array 上的 map 方法，将给定数组的每个元素按给定转换方法转换后得出新的数组。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=map](http://uniapp.dcloud.io/uniCloud/cf-database?id=map) + */ + map(mapOptions: MapOptions): any[]; + /** + * 将一个对象转换为数组。方法把对象的每个键值对都变成输出数组的一个元素，元素形如 { k: , v: }。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=objecttoarray](http://uniapp.dcloud.io/uniCloud/cf-database?id=objecttoarray) + */ + objectToArray(objectToArrayOptions: any): any[]; + /** + * 返回一组生成的序列数字。给定开始值、结束值、非零的步长，range 会返回从开始值开始逐步增长、步长为给定步长、但不包括结束值的序列。参数形式为：[起始值，结束值，步长] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=range](http://uniapp.dcloud.io/uniCloud/cf-database?id=range) + */ + range(rangeOptions: any[]): any[]; + /** + * 类似 JavaScript 的 reduce 方法，应用一个表达式于数组各个元素然后归一成一个元素。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=reduce](http://uniapp.dcloud.io/uniCloud/cf-database?id=reduce) + */ + reduce(reduceOptions: ReduceOptions): any; + /** + * 返回给定数组的倒序形式。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=reversearray](http://uniapp.dcloud.io/uniCloud/cf-database?id=reversearray) + */ + reverseArray(reverseArrayOptions: any[] | string): any[]; + /** + * 返回数组长度。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=size](http://uniapp.dcloud.io/uniCloud/cf-database?id=size) + */ + size(sizeOptions: any[] | string): number; + /** + * 类似 JavaScritp 的 slice 方法。返回给定数组的指定子集。参数形式：[数组,下标] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=slice](http://uniapp.dcloud.io/uniCloud/cf-database?id=slice) + */ + slice(sliceOptions: any[]): any[]; + /** + * 把二维数组的第二维数组中的相同序号的元素分别拼装成一个新的数组进而组装成一个新的二维数组。如可将 [ [ 1, 2, 3 ], [ "a", "b", + * "c" + * ] ] 转换成 [ [ 1, "a" ], [ 2, "b" ], [ 3, "c" ] ]。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=zip](http://uniapp.dcloud.io/uniCloud/cf-database?id=zip) + */ + zip(zipOptions: ZipOptions): any[]; + /** + * 给定多个表达式，and 仅在所有表达式都返回 true 时返回 true，否则返回 false 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=and](http://uniapp.dcloud.io/uniCloud/cf-database?id=and) + */ + and(andOptions: any[]): boolean; + /** + * 给定一个表达式，如果表达式返回 true，则 not 返回 false，否则返回 true。注意表达式不能为逻辑表达式（and、or、nor、not）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=not](http://uniapp.dcloud.io/uniCloud/cf-database?id=not) + */ + not(notOptions: string): boolean; + /** + * 给定多个表达式，如果任意一个表达式返回 true，则 or 返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=or](http://uniapp.dcloud.io/uniCloud/cf-database?id=or) + */ + or(orOptions: any[]): boolean; + /** + * 给定两个值，返回其比较值。如果第一个值小于第二个值，返回 -1 。如果第一个值大于第二个值，返回 1 。 如果两个值相等，返回 0 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=cmp](http://uniapp.dcloud.io/uniCloud/cf-database?id=cmp) + */ + cmp(cmpOptions: any[]): number; + /** + * 匹配两个值，如果相等则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=eq](http://uniapp.dcloud.io/uniCloud/cf-database?id=eq) + */ + eq(eqOptions: any[]): boolean; + /** + * 匹配两个值，如果前者大于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gt](http://uniapp.dcloud.io/uniCloud/cf-database?id=gt) + */ + gt(gtOptions: any[]): boolean; + /** + * 匹配两个值，如果前者大于或等于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gte](http://uniapp.dcloud.io/uniCloud/cf-database?id=gte) + */ + gte(gteOptions: any[]): boolean; + /** + * 匹配两个值，如果前者小于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lt](http://uniapp.dcloud.io/uniCloud/cf-database?id=lt) + */ + lt(ltOptions: any[]): boolean; + /** + * 匹配两个值，如果前者小于或等于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lte](http://uniapp.dcloud.io/uniCloud/cf-database?id=lte) + */ + lte(lteOptions: any[]): boolean; + /** + * 匹配两个值，如果不相等则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=neq](http://uniapp.dcloud.io/uniCloud/cf-database?id=neq) + */ + neq(neqOptions: any[]): boolean; + /** + * 计算布尔表达式，返回指定的两个值其中之一。参数形式为：[布尔表达式,真值,假值]，效果类似于 javascript 里的 condition?a:b + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=cond](http://uniapp.dcloud.io/uniCloud/cf-database?id=cond) + */ + cond(condOptions: any[]): any; + /** + * 计算给定的表达式，如果表达式结果为 null、undefined 或者不存在，那么返回一个替代值；否则返回原值。参数形式为：[表达式,替代值] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=ifnull](http://uniapp.dcloud.io/uniCloud/cf-database?id=ifnull) + */ + ifNull(ifNullOptions: any[]): any; + /** + * 根据给定的 switch-case-default 计算返回值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=switch](http://uniapp.dcloud.io/uniCloud/cf-database?id=switch) + */ + switch(switchOptions: SwitchOptions): boolean; + /** + * 给定日期的相关信息，构建并返回一个日期对象。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromparts](http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromparts) + */ + dateFromParts(dateFromPartsOptions: DateFromPartsOptions): DBDate; + /** + * 将一个日期/时间字符串转换为日期对象。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromstring](http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromstring) + */ + dateFromString(dateFromStringOptions: DateFromStringOptions): DBDate; + /** + * 根据指定的表达式将日期对象格式化为符合要求的字符串。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=datetostring](http://uniapp.dcloud.io/uniCloud/cf-database?id=datetostring) + */ + dateToString(dateToStringOptions: DateToStringOptions): string; + /** + * 返回日期字段对应的天数（一个月中的哪一天），是一个介于 1 至 31 之间的数字。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofmonth](http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofmonth) + */ + dayOfMonth(dayOfMonthOptions: string): number; + /** + * 返回日期字段对应的天数（一周中的第几天），是一个介于 1（周日）到 7（周六）之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofweek](http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofweek) + */ + dayOfWeek(dayOfWeekOptions: string): number; + /** + * 返回日期字段对应的天数（一年中的第几天），是一个介于 1 到 366 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofyear](http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofyear) + */ + dayOfYear(dayOfYearOptions: string): number; + /** + * 返回日期字段对应的小时数，是一个介于 0 到 23 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=hour](http://uniapp.dcloud.io/uniCloud/cf-database?id=hour) + */ + hour(hourOptions: string): number; + /** + * 返回日期字段对应的 ISO 8601 标准的天数（一周中的第几天），是一个介于 1（周一）到 7（周日）之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isodayofweek](http://uniapp.dcloud.io/uniCloud/cf-database?id=isodayofweek) + */ + isoDayOfWeek(isoDayOfWeekOptions: string): number; + /** + * 返回日期字段对应的 ISO 8601 标准的周数（一年中的第几周），是一个介于 1 到 53 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweek](http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweek) + */ + isoWeek(isoWeekOptions: string): void; + /** + * 返回日期字段对应的 ISO 8601 标准的天数（一年中的第几天）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweekyear](http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweekyear) + */ + isoWeekYear(isoWeekYearOptions: string): number; + /** + * 返回日期字段对应的毫秒数，是一个介于 0 到 999 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=millisecond](http://uniapp.dcloud.io/uniCloud/cf-database?id=millisecond) + */ + millisecond(millisecondOptions: string): number; + /** + * 返回日期字段对应的分钟数，是一个介于 0 到 59 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=minute](http://uniapp.dcloud.io/uniCloud/cf-database?id=minute) + */ + minute(minuteOptions: string): number; + /** + * 返回日期字段对应的月份，是一个介于 1 到 12 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=month](http://uniapp.dcloud.io/uniCloud/cf-database?id=month) + */ + month(monthOptions: string): number; + /** + * 返回日期字段对应的秒数，是一个介于 0 到 59 之间的整数，在特殊情况下（闰秒）可能等于 60。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=second](http://uniapp.dcloud.io/uniCloud/cf-database?id=second) + */ + second(secondOptions: string): number; + /** + * 返回日期字段对应的周数（一年中的第几周），是一个介于 0 到 53 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=week](http://uniapp.dcloud.io/uniCloud/cf-database?id=week) + */ + week(weekOptions: string): number; + /** + * 返回日期字段对应的年份。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=year](http://uniapp.dcloud.io/uniCloud/cf-database?id=year) + */ + year(yearOptions: string): number; + /** + * 直接返回一个值的字面量，不经过任何解析和处理。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=literal](http://uniapp.dcloud.io/uniCloud/cf-database?id=literal) + */ + literal(literalOptions: string): string; + /** + * 输入一个数组，或者数组字段的表达式。如果数组中所有元素均为真值，那么返回 true，否则返回 false。空数组永远返回 true。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=allelementstrue](http://uniapp.dcloud.io/uniCloud/cf-database?id=allelementstrue) + */ + allElementsTrue(allElementsTrueOptions: any[]): boolean; + /** + * 输入一个数组，或者数组字段的表达式。如果数组中任意一个元素为真值，那么返回 true，否则返回 false。空数组永远返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=anyelementtrue](http://uniapp.dcloud.io/uniCloud/cf-database?id=anyelementtrue) + */ + anyElementTrue(anyElementTrueOptions: any[]): boolean; + /** + * 输入两个集合，输出只存在于第一个集合中的元素。。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setdifference](http://uniapp.dcloud.io/uniCloud/cf-database?id=setdifference) + */ + setDifference(setDifferenceOptions: any[]): any; + /** + * 输入两个集合，判断两个集合中包含的元素是否相同（不考虑顺序、去重）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setequals](http://uniapp.dcloud.io/uniCloud/cf-database?id=setequals) + */ + setEquals(setEqualsOptions: any[]): boolean; + /** + * 输入两个集合，判断两个集合中包含的元素是否相同（不考虑顺序、去重）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setintersection](http://uniapp.dcloud.io/uniCloud/cf-database?id=setintersection) + */ + setIntersection(setIntersectionOptions: any[]): any; + /** + * 输入两个集合，判断第一个集合是否是第二个集合的子集。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setissubset](http://uniapp.dcloud.io/uniCloud/cf-database?id=setissubset) + */ + setIsSubset(setIsSubsetOptions: any[]): any; + /** + * 输入两个集合，输出两个集合的并集。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setunion](http://uniapp.dcloud.io/uniCloud/cf-database?id=setunion) + */ + setUnion(setUnionOptions: any[]): any; + /** + * 连接字符串，返回拼接后的字符串。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=concat](http://uniapp.dcloud.io/uniCloud/cf-database?id=concat) + */ + concat(concatOptions: any[]): string; + /** + * 在目标字符串中查找子字符串，并返回第一次出现的 UTF-8 的字节索引（从0开始）。如果不存在子字符串，返回 -1。参数形式为：[目标字符串表达式, 子字符串表达式, 开始位置, + * 结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofbytes](http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofbytes) + */ + indexOfBytes(indexOfBytesOptions: any[]): number; + /** + * 在目标字符串中查找子字符串，并返回第一次出现的 UTF-8 的 code point 索引（从0开始）。如果不存在子字符串，返回 -1。参数形式为：[目标字符串表达式, + * 子字符串表达式, 开始位置, + * 结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofcp](http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofcp) + */ + indexOfCP(indexOfCPOptions: any[]): number; + /** + * 按照分隔符分隔字符串，并且删除分隔符，返回子字符串组成的数组。如果字符串无法找到分隔符进行分隔，返回原字符串作为数组的唯一元素。参数形式为：[字符串,分隔符] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=split](http://uniapp.dcloud.io/uniCloud/cf-database?id=split) + */ + split(splitOptions: string): any[]; + /** + * 计算并返回指定字符串中 utf-8 编码的字节数量。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=strlenbytes](http://uniapp.dcloud.io/uniCloud/cf-database?id=strlenbytes) + */ + strLenBytes(strLenBytesOptions: string): number; + /** + * 计算并返回指定字符串的UTF-8 code points 数量。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=strlencp](http://uniapp.dcloud.io/uniCloud/cf-database?id=strlencp) + */ + strLenCP(strLenCPOptions: string): number; + /** + * 对两个字符串在不区分大小写的情况下进行大小比较，并返回比较的结果。如果第一个值小于第二个值，返回 -1 。如果第一个值大于第二个值，返回 1 。 如果两个值相等，返回 0 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=strcasecmp](http://uniapp.dcloud.io/uniCloud/cf-database?id=strcasecmp) + */ + strcasecmp(strcasecmpOptions: any[]): number; + /** + * 返回字符串从指定位置开始的指定长度的子字符串。它是 db.command.aggregate.substrBytes + * 的别名，更推荐使用后者。参数形式为：[字符串,起始位置,结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=substr](http://uniapp.dcloud.io/uniCloud/cf-database?id=substr) + */ + substr(substrOptions: any[]): string; + /** + * 返回字符串从指定位置开始的指定长度的子字符串。子字符串是由字符串中指定的 UTF-8 字节索引的字符开始，长度为指定的字节数。参数形式为：[字符串,起始位置,结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=substrbytes](http://uniapp.dcloud.io/uniCloud/cf-database?id=substrbytes) + */ + substrBytes(substrBytesOptions: any[]): string; + /** + * 返回字符串从指定位置开始的指定长度的子字符串。子字符串是由字符串中指定的 UTF-8 字节索引的字符开始，长度为指定的字节数。参数形式为：[字符串,起始位置,结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=substrcp](http://uniapp.dcloud.io/uniCloud/cf-database?id=substrcp) + */ + substrCP(substrCPOptions: any[]): string; + /** + * 将字符串转化为小写并返回。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=tolower](http://uniapp.dcloud.io/uniCloud/cf-database?id=tolower) + */ + toLower(toLowerOptions: string): string; + /** + * 将字符串转化为大写并返回。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=toupper](http://uniapp.dcloud.io/uniCloud/cf-database?id=toupper) + */ + toUpper(toUpperOptions: string): string; + /** + * 向数组中添加值，如果数组中已存在该值，不执行任何操作。它只能在 group 阶段中使用。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=addtoset](http://uniapp.dcloud.io/uniCloud/cf-database?id=addtoset) + */ + addToSet(addToSetOptions: string): void; + /** + * 返回一组集合中，指定字段对应数据的平均值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=avg](http://uniapp.dcloud.io/uniCloud/cf-database?id=avg) + */ + avg(avgOptions: string): void; + /** + * 返回指定字段在一组集合的第一条记录对应的值。仅当这组集合是按照某种定义排序（ sort ）后，此操作才有意义。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=first](http://uniapp.dcloud.io/uniCloud/cf-database?id=first) + */ + first(firstOptions: string): void; + /** + * 返回指定字段在一组集合的最后一条记录对应的值。仅当这组集合是按照某种定义排序（ sort ）后，此操作才有意义。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=last](http://uniapp.dcloud.io/uniCloud/cf-database?id=last) + */ + last(lastOptions: string): void; + /** + * 返回一组数值的最大值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=max](http://uniapp.dcloud.io/uniCloud/cf-database?id=max) + */ + max(maxOptions: string): void; + /** + * 返回一组数值的最小值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=min](http://uniapp.dcloud.io/uniCloud/cf-database?id=min) + */ + min(minOptions: string): void; + /** + * 将多个文档合并为单个文档 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=mergeobjects](http://uniapp.dcloud.io/uniCloud/cf-database?id=mergeobjects) + */ + mergeObjects(mergeObjectsOptions: string | any[]): void; + /** + * 在 group 阶段，返回一组中表达式指定列与对应的值，一起组成的数组。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=push-1](http://uniapp.dcloud.io/uniCloud/cf-database?id=push-1) + */ + push(pushOptions: any): void; + /** + * 返回一组字段对应值的标准差。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevpop](http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevpop) + */ + stdDevPop(stdDevPopOptions: string): void; + /** + * 计算输入值的样本标准偏差。如果输入值代表数据总体，或者不概括更多的数据，请改用 db.command.aggregate.stdDevPop 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevsamp](http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevsamp) + */ + stdDevSamp(stdDevSampOptions: string): void; + /** + * 计算并且返回一组字段所有数值的总和。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=sum](http://uniapp.dcloud.io/uniCloud/cf-database?id=sum) + */ + sum(sumOptions: string): void; + /** + * 自定义变量，并且在指定表达式中使用，返回的结果是表达式的结果。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=let](http://uniapp.dcloud.io/uniCloud/cf-database?id=let) + */ + let(letOptions: LetOptions): void; + } + + interface ISerializedPoint { + type: string; + coordinates: any; + } + + interface Point { + /** + * 纬度 + */ + latitude: number; + /** + * 经度 + */ + longitude: number; + _internalType: any; + parse(key: any): any; + /** + * 返回相应的 GeoJSON 结构的对象 + */ + toJSON(): any; + /** + * 转换成可读字符串 + */ + toReadableString(): string; + validate(point: ISerializedPoint): boolean; + } + + interface IGeoNearOptions { + /** + * 地理位置点 (Point) + */ + geometry: Point; + /** + * 选填，最大距离，单位为米 + */ + maxDistance: number; + /** + * 选填，最小距离，单位为米 + */ + minDistance: number; + } + + interface IGeoWithinOptions { + /** + * 地理信息结构，Polygon，MultiPolygon，或 { centerSphere } + */ + geometry: any; + } + + interface IGeoIntersectsOptions { + /** + * 地理信息结构，Point + */ + geometry: any; + } + interface QueryCommand { + operator: QUERY_COMMANDS_LITERAL; + /** + * 聚合操作符 + */ + aggregate: AggregateCommand; + _setFieldName(fieldName: string): QueryCommand; + /** + * 用于设定字段等于指定值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=set](http://uniapp.dcloud.io/uniCloud/cf-database?id=set) + */ + set(): void; + /** + * 用于指示字段自增某个值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=inc](http://uniapp.dcloud.io/uniCloud/cf-database?id=inc) + */ + inc(): void; + /** + * 用于指示字段自乘某个值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=mul](http://uniapp.dcloud.io/uniCloud/cf-database?id=mul) + */ + mul(): void; + /** + * 向数组尾部追加元素，支持传入单个元素或数组 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=push](http://uniapp.dcloud.io/uniCloud/cf-database?id=push) + */ + push(): void; + /** + * 删除数组尾部元素 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=pop](http://uniapp.dcloud.io/uniCloud/cf-database?id=pop) + */ + pop(): void; + /** + * 向数组头部添加元素，支持传入单个元素或数组 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=unshift](http://uniapp.dcloud.io/uniCloud/cf-database?id=unshift) + */ + unshift(): void; + /** + * 删除数组头部元素 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=set](http://uniapp.dcloud.io/uniCloud/cf-database?id=set) + */ + shift(): void; + /** + * 查询筛选条件，表示字段等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=eq](http://uniapp.dcloud.io/uniCloud/cf-database?id=eq) + */ + eq(val: any): LogicCommand; + /** + * 查询筛选条件，表示字段不等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=neq](http://uniapp.dcloud.io/uniCloud/cf-database?id=neq) + */ + neq(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需大于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gt](http://uniapp.dcloud.io/uniCloud/cf-database?id=gt) + */ + gt(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需大于或等于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gte](http://uniapp.dcloud.io/uniCloud/cf-database?id=gte) + */ + gte(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需小于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lt](http://uniapp.dcloud.io/uniCloud/cf-database?id=lt) + */ + lt(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需小于或等于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lte](http://uniapp.dcloud.io/uniCloud/cf-database?id=lte) + */ + lte(val: any): LogicCommand; + /** + * 查询筛选操作符，表示要求值在给定的数组内。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=in](http://uniapp.dcloud.io/uniCloud/cf-database?id=in) + */ + in(list: any): LogicCommand; + /** + * 查询筛选操作符，表示要求值不在给定的数组内。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=nin](http://uniapp.dcloud.io/uniCloud/cf-database?id=nin) + */ + nin(list: any): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件。或指令有两种用法，一是可以进行字段值的 “或” 操作，二是也可以进行跨字段的 “或” 操作。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=or-1](http://uniapp.dcloud.io/uniCloud/cf-database?id=or-1) + */ + or(val: any): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=and-1](http://uniapp.dcloud.io/uniCloud/cf-database?id=and-1) + */ + and(val: any): LogicCommand; + /** + * 按从近到远的顺序，找出字段值在给定点的附近的记录。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=geonear](http://uniapp.dcloud.io/uniCloud/cf-database?id=geonear) + */ + geoNear(val: IGeoNearOptions): LogicCommand; + /** + * 找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=geowithin](http://uniapp.dcloud.io/uniCloud/cf-database?id=geowithin) + */ + geoWithin(val: IGeoWithinOptions): LogicCommand; + /** + * 找出给定的地理位置图形相交的记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=geointersects](http://uniapp.dcloud.io/uniCloud/cf-database?id=geointersects) + */ + geoIntersects(val: IGeoIntersectsOptions): LogicCommand; + } + interface GeoType { + /** + * 数据库地理位置结构集 + */ + Point: any; + } + + interface Query { + /** + * 获取记录数据，或获取根据查询条件筛选后的记录数据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=query](http://uniapp.dcloud.io/uniCloud/cf-database?id=query) + */ + get(GetParam?: GetParam): Promise; + /** + * 延迟查询请求 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=multi-send](http://uniapp.dcloud.io/uniCloud/jql?id=multi-send) + */ + getTemp(GetParam?: GetParam): GetTempQuery; + /** + * 统计匹配查询条件的记录的条数 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=count](http://uniapp.dcloud.io/uniCloud/cf-database?id=count) + */ + count(): Promise; + /** + * 指定查询条件，返回带新查询条件的新的集合引用 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=where](http://uniapp.dcloud.io/uniCloud/cf-database?id=where) + */ + where(query: any): Query; + /** + * 指定查询排序条件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=order-by](http://uniapp.dcloud.io/uniCloud/cf-database?id=order-by) + */ + orderBy(fieldPath: string, directionStr: 'desc' | 'asc'): Query; + /** + * 指定查询结果集数量上限 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=limit](http://uniapp.dcloud.io/uniCloud/cf-database?id=limit) + */ + limit(limit: number): Query; + /** + * 指定查询返回结果时从指定序列后的结果开始返回，常用于分页 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=skip](http://uniapp.dcloud.io/uniCloud/cf-database?id=skip) + */ + skip(offset: number): Query; + /** + * 更新多条记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=update](http://uniapp.dcloud.io/uniCloud/cf-database?id=update) + */ + update(data: any): Promise; + /** + * 指定返回结果中记录需返回的字段 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=field](http://uniapp.dcloud.io/uniCloud/cf-database?id=field) + */ + field(projection: any): Query; + /** + * 指定要使用的foreignKey + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=lookup-foreign-key](http://uniapp.dcloud.io/uniCloud/jql?id=lookup-foreign-key) + */ + foreignKey(foreignKeyName: string): Query; + /** + * 指定分组依据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + groupBy(projection: string): Query; + /** + * 指定统计指标 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + groupField(projection: string): Query; + /** + * 删除多条记录。注意只支持通过匹配 where 语句来删除，不支持 skip 和 limit + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=remove](http://uniapp.dcloud.io/uniCloud/cf-database?id=remove) + */ + remove(): Promise; + } + + interface AggregateReference { + /** + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-add-fields](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-add-fields) + */ + addFields(addFieldsOptions: any): AggregateReference; + /** + * 将输入记录根据给定的条件和边界划分成不同的组，每组即一个bucket + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-bucket](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-bucket) + */ + bucket(bucketOptions: BucketOptions): AggregateReference; + /** + * 将输入记录根据给定的条件划分成不同的组，每组即一个 bucket。与 bucket 的其中一个不同之处在于无需指定 boundaries，bucketAuto + * 会自动尝试将记录尽可能平均的分散到每组中。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-bucket-auto](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-bucket-auto) + */ + bucketAuto(bucketAutoOptions: BucketAutoOptions): AggregateReference; + /** + * 计算上一聚合阶段输入到本阶段的记录数，输出一个记录，其中指定字段的值为记录数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-count](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-count) + */ + count(countOptions: string): AggregateReference; + /** + * 将输入记录按给定表达式分组，输出时每个记录代表一个分组，每个记录的 _id 是区分不同组的 key。输出记录中也可以包括累计值，将输出字段设为累计值即会从该分组中计算累计值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-group](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-group) + */ + group(groupOptions: any): AggregateReference; + /** + * 限制输出到下一阶段的记录数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-limit](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-limit) + */ + limit(limitOptions: number): AggregateReference; + /** + * 联表查询。与同个数据库下的一个指定的集合做 left outer join(左外连接)。对该阶段的每一个输入记录，lookup + * 会在该记录中增加一个数组字段，该数组是被联表中满足匹配条件的记录列表。lookup 会将连接后的结果输出给下个阶段。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-lookup](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-lookup) + */ + lookup(lookupOptions: LookupOptions | LookupPipelineOptions): AggregateReference; + /** + * 根据条件过滤文档，并且把符合条件的文档传递给下一个流水线阶段。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-match](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-match) + */ + match(matchOptions: any): AggregateReference; + /** + * 把指定的字段传递给下一个流水线，指定的字段可以是某个已经存在的字段，也可以是计算出来的新字段。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-project](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-project) + */ + project(projectOptions: any): AggregateReference; + /** + * 指定一个已有字段作为输出的根节点，也可以指定一个计算出的新字段作为根节点。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-replace-root](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-replace-root) + */ + replaceRoot(replaceRootOptions: ReplaceRootOptions): AggregateReference; + /** + * 随机从文档中选取指定数量的记录。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-sample](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-sample) + */ + sample(sampleOptions: SampleOptions): AggregateReference; + /** + * 指定一个正整数，跳过对应数量的文档，输出剩下的文档。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-skip](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-skip) + */ + skip(skipOptions: number): AggregateReference; + /** + * 根据指定的字段，对输入的文档进行排序。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-sort](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-sort) + */ + sort(sortOptions: any): AggregateReference; + /** + * 根据指定的字段，对输入的文档进行排序。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-sort-by-count](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-sort-by-count) + */ + sortByCount(sortByCountOptions: string): AggregateReference; + /** + * 使用指定的数组字段中的每个元素，对文档进行拆分。拆分后，文档会从一个变为一个或多个，分别对应数组的每个元素。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-unwind](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-unwind) + */ + unwind(unwindOptions: UnwindOptions | string): void; + /** + * 标志聚合操作定义完成，发起实际聚合操作 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-end](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate-end) + */ + end(): Promise; + } + + interface DocumentReference { + /** + * 文档ID + */ + id: string; + /** + * 返回结果中记录需返回的字段 + */ + projection: any; + /** + * 替换更新一条记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=doc-set](http://uniapp.dcloud.io/uniCloud/cf-database?id=doc-set) + */ + set(data: any): Promise; + /** + * 更新一条记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=where-update](http://uniapp.dcloud.io/uniCloud/cf-database?id=where-update) + */ + update(data: any): Promise; + /** + * 删除一条记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=remove](http://uniapp.dcloud.io/uniCloud/cf-database?id=remove) + */ + remove(): Promise; + /** + * 获取记录数据，或获取根据查询条件筛选后的记录数据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=query](http://uniapp.dcloud.io/uniCloud/cf-database?id=query) + */ + get(GetParam?: GetParam): Promise; + /** + * 获取记录数据，或获取根据查询条件筛选后的记录数据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=multi-send](http://uniapp.dcloud.io/uniCloud/jql?id=multi-send) + */ + getTemp(GetParam?: GetParam): GetTempQuery; + /** + * 指定返回结果中记录需返回的字段 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=field](http://uniapp.dcloud.io/uniCloud/cf-database?id=field) + */ + field(projection: string): DocumentReference; + /** + * 指定要使用的foreignKey + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=lookup-foreign-key](http://uniapp.dcloud.io/uniCloud/jql?id=lookup-foreign-key) + */ + foreignKey(foreignKeyName: string): DocumentReference; + /** + * 指定返回结果中记录需返回的字段 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + preField(projection: string): Query; + /** + * 指定分组依据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + groupBy(projection: string): Query; + /** + * 指定统计指标 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + groupField(projection: string): Query; + } + + interface CollectionReference { + name: string; + /** + * 获取集合中指定记录的引用。方法接受一个 id 参数，指定需引用的记录的 _id + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=doc](http://uniapp.dcloud.io/uniCloud/cf-database?id=doc) + */ + doc(docID: string): DocumentReference; + /** + * 新增记录，如果传入的记录对象没有 _id 字段，则由后台自动生成 _id；若指定了 _id，则不能与已有记录冲突 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=add](http://uniapp.dcloud.io/uniCloud/cf-database?id=add) + */ + add(data: any): Promise; + /** + * 获取记录数据，或获取根据查询条件筛选后的记录数据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=query](http://uniapp.dcloud.io/uniCloud/cf-database?id=query) + */ + get(GetParam?: GetParam): Promise; + /** + * 延迟查询请求 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=multi-send](http://uniapp.dcloud.io/uniCloud/jql?id=multi-send) + */ + getTemp(GetParam?: GetParam): GetTempQuery; + /** + * 统计匹配查询条件的记录的条数 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=count](http://uniapp.dcloud.io/uniCloud/cf-database?id=count) + */ + count(): any; + /** + * 指定查询条件，返回带新查询条件的新的集合引用 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=where](http://uniapp.dcloud.io/uniCloud/cf-database?id=where) + */ + where(query: any): Query; + /** + * 指定查询排序条件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=order-by](http://uniapp.dcloud.io/uniCloud/cf-database?id=order-by) + */ + orderBy(fieldPath: string, directionStr: 'desc' | 'asc'): Query; + /** + * 指定查询结果集数量上限 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=limit](http://uniapp.dcloud.io/uniCloud/cf-database?id=limit) + */ + limit(limit: number): Query; + /** + * 指定查询返回结果时从指定序列后的结果开始返回，常用于分页 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=skip](http://uniapp.dcloud.io/uniCloud/cf-database?id=skip) + */ + skip(offset: number): Query; + /** + * 更新多条记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=update](http://uniapp.dcloud.io/uniCloud/cf-database?id=update) + */ + update(data: any): Promise; + /** + * 指定返回结果中记录需返回的字段 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=field](http://uniapp.dcloud.io/uniCloud/cf-database?id=field) + */ + field(projection: string): Query; + /** + * 指定要使用的foreignKey + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=lookup-foreign-key](http://uniapp.dcloud.io/uniCloud/jql?id=lookup-foreign-key) + */ + foreignKey(foreignKeyName: string): Query; + /** + * 指定返回结果中记录需返回的字段 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + preField(projection: string): Query; + /** + * 指定分组依据 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + groupBy(projection: string): Query; + /** + * 指定统计指标 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=groupby](http://uniapp.dcloud.io/uniCloud/jql?id=groupby) + */ + groupField(projection: string): Query; + /** + * 删除多条记录。注意只支持通过匹配 where 语句来删除，不支持 skip 和 limit + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=remove](http://uniapp.dcloud.io/uniCloud/cf-database?id=remove) + */ + remove(): Promise; + /** + * 获取数据库集合的聚合操作实例 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate](http://uniapp.dcloud.io/uniCloud/cf-database?id=aggregate) + */ + aggregate(): AggregateReference; + } + + type DatabaseEventName = 'refreshToken' | 'error' + interface Database { + /** + * 监听数据库事件 + * + * 文档: [https://uniapp.dcloud.net.cn/uniCloud/clientdb.html#event](https://uniapp.dcloud.net.cn/uniCloud/clientdb.html#event) + */ + on(event: DatabaseEventName, callback: (result: any) => any): void + /** + * 数据库地理位置结构集 + */ + Geo: GeoType; + /** + * 数据库操作符 + */ + command: QueryCommand; + /** + * 正则表达式查询 + */ + RegExp: any; + /** + * 创建一个服务端当前时间的标记 + */ + serverDate: any; + config: any; + /** + * 数据库集合引用 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=collection](http://uniapp.dcloud.io/uniCloud/cf-database?id=collection) + */ + collection(collName: string): CollectionReference; + /** + * 指定数据库操作需要执行的action + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=action](http://uniapp.dcloud.io/uniCloud/jql?id=action) + */ + action(actionName: string): Database; + /** + * 获取云端环境变量 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=variable](http://uniapp.dcloud.io/uniCloud/jql?id=variable) + */ + getCloudEnv(envStr: '$cloudEnv_uid' | '$cloudEnv_now' | '$cloudEnv_clientIP'): any; + /** + * 同时执行多次数据库查询操作 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=multi-send](http://uniapp.dcloud.io/uniCloud/jql?id=multi-send) + */ + multiSend(tempQuery1: GetTempQuery, tempQuery2?: GetTempQuery, tempQuery3?: GetTempQuery, tempQuery4?: GetTempQuery, tempQuery5?: GetTempQuery, tempQuery6?: GetTempQuery, tempQuery7?: GetTempQuery, tempQuery8?: GetTempQuery): Promise; + } + + interface UpdateCommand { + fieldName: any; + operator: UPDATE_COMMANDS_LITERAL; + operands: any; + _internalType: InternalSymbol; + _setFieldName(fieldName: string): UpdateCommand; + } + + interface QueryCommand { + operator: QUERY_COMMANDS_LITERAL; + /** + * 聚合操作符 + */ + aggregate: AggregateCommand; + _setFieldName(fieldName: string): QueryCommand; + /** + * 用于设定字段等于指定值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=set](http://uniapp.dcloud.io/uniCloud/cf-database?id=set) + */ + set(): void; + /** + * 用于指示字段自增某个值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=inc](http://uniapp.dcloud.io/uniCloud/cf-database?id=inc) + */ + inc(): void; + /** + * 用于指示字段自乘某个值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=mul](http://uniapp.dcloud.io/uniCloud/cf-database?id=mul) + */ + mul(): void; + /** + * 向数组尾部追加元素，支持传入单个元素或数组 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=push](http://uniapp.dcloud.io/uniCloud/cf-database?id=push) + */ + push(): void; + /** + * 删除数组尾部元素 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=pop](http://uniapp.dcloud.io/uniCloud/cf-database?id=pop) + */ + pop(): void; + /** + * 向数组头部添加元素，支持传入单个元素或数组 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=unshift](http://uniapp.dcloud.io/uniCloud/cf-database?id=unshift) + */ + unshift(): void; + /** + * 删除数组头部元素 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=set](http://uniapp.dcloud.io/uniCloud/cf-database?id=set) + */ + shift(): void; + /** + * 查询筛选条件，表示字段等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=eq](http://uniapp.dcloud.io/uniCloud/cf-database?id=eq) + */ + eq(val: any): LogicCommand; + /** + * 查询筛选条件，表示字段不等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=neq](http://uniapp.dcloud.io/uniCloud/cf-database?id=neq) + */ + neq(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需大于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gt](http://uniapp.dcloud.io/uniCloud/cf-database?id=gt) + */ + gt(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需大于或等于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gte](http://uniapp.dcloud.io/uniCloud/cf-database?id=gte) + */ + gte(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需小于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lt](http://uniapp.dcloud.io/uniCloud/cf-database?id=lt) + */ + lt(val: any): LogicCommand; + /** + * 查询筛选操作符，表示需小于或等于指定值。可以传入 Date 对象用于进行日期比较。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lte](http://uniapp.dcloud.io/uniCloud/cf-database?id=lte) + */ + lte(val: any): LogicCommand; + /** + * 查询筛选操作符，表示要求值在给定的数组内。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=in](http://uniapp.dcloud.io/uniCloud/cf-database?id=in) + */ + in(list: any): LogicCommand; + /** + * 查询筛选操作符，表示要求值不在给定的数组内。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=nin](http://uniapp.dcloud.io/uniCloud/cf-database?id=nin) + */ + nin(list: any): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件。或指令有两种用法，一是可以进行字段值的 “或” 操作，二是也可以进行跨字段的 “或” 操作。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=or-1](http://uniapp.dcloud.io/uniCloud/cf-database?id=or-1) + */ + or(val: any): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=and-1](http://uniapp.dcloud.io/uniCloud/cf-database?id=and-1) + */ + and(val: any): LogicCommand; + /** + * 按从近到远的顺序，找出字段值在给定点的附近的记录。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=geonear](http://uniapp.dcloud.io/uniCloud/cf-database?id=geonear) + */ + geoNear(val: IGeoNearOptions): LogicCommand; + /** + * 找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=geowithin](http://uniapp.dcloud.io/uniCloud/cf-database?id=geowithin) + */ + geoWithin(val: IGeoWithinOptions): LogicCommand; + /** + * 找出给定的地理位置图形相交的记录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=geointersects](http://uniapp.dcloud.io/uniCloud/cf-database?id=geointersects) + */ + geoIntersects(val: IGeoIntersectsOptions): LogicCommand; + } + + interface AggregateCommand { + /** + * 返回一个数字的绝对值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=abs](http://uniapp.dcloud.io/uniCloud/cf-database?id=abs) + */ + abs(absOptions: number | string): number; + /** + * 将数字相加或将数字加在日期上。如果数组中的其中一个值是日期，那么其他值将被视为毫秒数加在该日期上。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=add](http://uniapp.dcloud.io/uniCloud/cf-database?id=add) + */ + add(addOptions: any[]): number; + /** + * 向上取整，返回大于或等于给定数字的最小整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=ceil](http://uniapp.dcloud.io/uniCloud/cf-database?id=ceil) + */ + ceil(ceilOptions: number | string): number; + /** + * 传入被除数和除数，求商。参数形式为：[被除数,除数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=divide](http://uniapp.dcloud.io/uniCloud/cf-database?id=divide) + */ + divide(divideOptions: any[]): number; + /** + * 取 e（自然对数的底数，欧拉数） 的 n 次方 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=exp](http://uniapp.dcloud.io/uniCloud/cf-database?id=exp) + */ + exp(expOptions: number | string): number; + /** + * 向下取整，返回大于或等于给定数字的最小整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=floor](http://uniapp.dcloud.io/uniCloud/cf-database?id=floor) + */ + floor(floorOptions: number | string): number; + /** + * 计算给定数字在自然对数值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=ln](http://uniapp.dcloud.io/uniCloud/cf-database?id=ln) + */ + ln(lnOptions: number | string): number; + /** + * 计算给定数字在给定对数底下的 log 值。参数形式为：[真数,底数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=log](http://uniapp.dcloud.io/uniCloud/cf-database?id=log) + */ + log(logOptions: any[]): number; + /** + * 计算给定数字在对数底为 10 下的 log 值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=log10](http://uniapp.dcloud.io/uniCloud/cf-database?id=log10) + */ + log10(log10Options: number | string): number; + /** + * 取模运算，取数字取模后的值。参数形式为：[被除数,除数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=mod](http://uniapp.dcloud.io/uniCloud/cf-database?id=mod) + */ + mod(modOptions: any[]): number; + /** + * 取传入的数字参数相乘的结果。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=multiply](http://uniapp.dcloud.io/uniCloud/cf-database?id=multiply) + */ + multiply(multiplyOptions: any[]): number; + /** + * 求给定基数的指数次幂。参数形式为：[底数,指数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=pow](http://uniapp.dcloud.io/uniCloud/cf-database?id=pow) + */ + pow(powOptions: any[]): number; + /** + * 求平方根。参数形式为：[被开方数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=sqrt](http://uniapp.dcloud.io/uniCloud/cf-database?id=sqrt) + */ + sqrt(sqrtOptions: any[]): number; + /** + * 将两个数字相减然后返回差值，或将两个日期相减然后返回相差的毫秒数，或将一个日期减去一个数字返回结果的日期。参数形式为：[被减数,减数] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=subtract](http://uniapp.dcloud.io/uniCloud/cf-database?id=subtract) + */ + subtract(subtractOptions: any[]): number; + /** + * 将数字截断为整形。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=trunc](http://uniapp.dcloud.io/uniCloud/cf-database?id=trunc) + */ + trunc(truncOptions: number | string): number; + /** + * 返回在指定数组下标的元素。参数形式为：[数组,下标] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=arrayelemat](http://uniapp.dcloud.io/uniCloud/cf-database?id=arrayelemat) + */ + arrayElemAt(arrayElemAtOptions: any[]): any; + /** + * 将一个数组转换为对象。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=arraytoobject](http://uniapp.dcloud.io/uniCloud/cf-database?id=arraytoobject) + */ + arrayToObject(arrayToObjectOptions: any[] | string): any; + /** + * 将多个数组拼接成一个数组。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=concatarrays](http://uniapp.dcloud.io/uniCloud/cf-database?id=concatarrays) + */ + concatArrays(concatArraysOptions: any[]): any[]; + /** + * 根据给定条件返回满足条件的数组的子集。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=filter](http://uniapp.dcloud.io/uniCloud/cf-database?id=filter) + */ + filter(filterOptions: FilterOptions): any[]; + /** + * 给定一个值和一个数组，如果值在数组中则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=in](http://uniapp.dcloud.io/uniCloud/cf-database?id=in) + */ + in(inOptions: number | string): number; + /** + * 在数组中找出等于给定值的第一个元素的下标，如果找不到则返回 -1。参数形式为：[数组,查找值,起始索引,结束索引]，起始索引、结束索引为可选值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofarray](http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofarray) + */ + indexOfArray(indexOfArrayOptions: any[]): number; + /** + * 判断给定表达式是否是数组，返回布尔值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isarray](http://uniapp.dcloud.io/uniCloud/cf-database?id=isarray) + */ + isArray(isArrayOptions: any[]): boolean; + /** + * 类似 JavaScript Array 上的 map 方法，将给定数组的每个元素按给定转换方法转换后得出新的数组。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=map](http://uniapp.dcloud.io/uniCloud/cf-database?id=map) + */ + map(mapOptions: MapOptions): any[]; + /** + * 将一个对象转换为数组。方法把对象的每个键值对都变成输出数组的一个元素，元素形如 { k: , v: }。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=objecttoarray](http://uniapp.dcloud.io/uniCloud/cf-database?id=objecttoarray) + */ + objectToArray(objectToArrayOptions: any): any[]; + /** + * 返回一组生成的序列数字。给定开始值、结束值、非零的步长，range 会返回从开始值开始逐步增长、步长为给定步长、但不包括结束值的序列。参数形式为：[起始值，结束值，步长] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=range](http://uniapp.dcloud.io/uniCloud/cf-database?id=range) + */ + range(rangeOptions: any[]): any[]; + /** + * 类似 JavaScript 的 reduce 方法，应用一个表达式于数组各个元素然后归一成一个元素。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=reduce](http://uniapp.dcloud.io/uniCloud/cf-database?id=reduce) + */ + reduce(reduceOptions: ReduceOptions): any; + /** + * 返回给定数组的倒序形式。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=reversearray](http://uniapp.dcloud.io/uniCloud/cf-database?id=reversearray) + */ + reverseArray(reverseArrayOptions: any[] | string): any[]; + /** + * 返回数组长度。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=size](http://uniapp.dcloud.io/uniCloud/cf-database?id=size) + */ + size(sizeOptions: any[] | string): number; + /** + * 类似 JavaScritp 的 slice 方法。返回给定数组的指定子集。参数形式：[数组,下标] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=slice](http://uniapp.dcloud.io/uniCloud/cf-database?id=slice) + */ + slice(sliceOptions: any[]): any[]; + /** + * 把二维数组的第二维数组中的相同序号的元素分别拼装成一个新的数组进而组装成一个新的二维数组。如可将 [ [ 1, 2, 3 ], [ "a", "b", + * "c" + * ] ] 转换成 [ [ 1, "a" ], [ 2, "b" ], [ 3, "c" ] ]。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=zip](http://uniapp.dcloud.io/uniCloud/cf-database?id=zip) + */ + zip(zipOptions: ZipOptions): any[]; + /** + * 给定多个表达式，and 仅在所有表达式都返回 true 时返回 true，否则返回 false 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=and](http://uniapp.dcloud.io/uniCloud/cf-database?id=and) + */ + and(andOptions: any[]): boolean; + /** + * 给定一个表达式，如果表达式返回 true，则 not 返回 false，否则返回 true。注意表达式不能为逻辑表达式（and、or、nor、not）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=not](http://uniapp.dcloud.io/uniCloud/cf-database?id=not) + */ + not(notOptions: string): boolean; + /** + * 给定多个表达式，如果任意一个表达式返回 true，则 or 返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=or](http://uniapp.dcloud.io/uniCloud/cf-database?id=or) + */ + or(orOptions: any[]): boolean; + /** + * 给定两个值，返回其比较值。如果第一个值小于第二个值，返回 -1 。如果第一个值大于第二个值，返回 1 。 如果两个值相等，返回 0 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=cmp](http://uniapp.dcloud.io/uniCloud/cf-database?id=cmp) + */ + cmp(cmpOptions: any[]): number; + /** + * 匹配两个值，如果相等则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=eq](http://uniapp.dcloud.io/uniCloud/cf-database?id=eq) + */ + eq(eqOptions: any[]): boolean; + /** + * 匹配两个值，如果前者大于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gt](http://uniapp.dcloud.io/uniCloud/cf-database?id=gt) + */ + gt(gtOptions: any[]): boolean; + /** + * 匹配两个值，如果前者大于或等于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=gte](http://uniapp.dcloud.io/uniCloud/cf-database?id=gte) + */ + gte(gteOptions: any[]): boolean; + /** + * 匹配两个值，如果前者小于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lt](http://uniapp.dcloud.io/uniCloud/cf-database?id=lt) + */ + lt(ltOptions: any[]): boolean; + /** + * 匹配两个值，如果前者小于或等于后者则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=lte](http://uniapp.dcloud.io/uniCloud/cf-database?id=lte) + */ + lte(lteOptions: any[]): boolean; + /** + * 匹配两个值，如果不相等则返回 true，否则返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=neq](http://uniapp.dcloud.io/uniCloud/cf-database?id=neq) + */ + neq(neqOptions: any[]): boolean; + /** + * 计算布尔表达式，返回指定的两个值其中之一。参数形式为：[布尔表达式,真值,假值]，效果类似于 javascript 里的 condition?a:b + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=cond](http://uniapp.dcloud.io/uniCloud/cf-database?id=cond) + */ + cond(condOptions: any[]): any; + /** + * 计算给定的表达式，如果表达式结果为 null、undefined 或者不存在，那么返回一个替代值；否则返回原值。参数形式为：[表达式,替代值] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=ifnull](http://uniapp.dcloud.io/uniCloud/cf-database?id=ifnull) + */ + ifNull(ifNullOptions: any[]): any; + /** + * 根据给定的 switch-case-default 计算返回值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=switch](http://uniapp.dcloud.io/uniCloud/cf-database?id=switch) + */ + switch(switchOptions: SwitchOptions): boolean; + /** + * 给定日期的相关信息，构建并返回一个日期对象。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromparts](http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromparts) + */ + dateFromParts(dateFromPartsOptions: DateFromPartsOptions): DBDate; + /** + * 将一个日期/时间字符串转换为日期对象。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromstring](http://uniapp.dcloud.io/uniCloud/cf-database?id=datefromstring) + */ + dateFromString(dateFromStringOptions: DateFromStringOptions): DBDate; + /** + * 根据指定的表达式将日期对象格式化为符合要求的字符串。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=datetostring](http://uniapp.dcloud.io/uniCloud/cf-database?id=datetostring) + */ + dateToString(dateToStringOptions: DateToStringOptions): string; + /** + * 返回日期字段对应的天数（一个月中的哪一天），是一个介于 1 至 31 之间的数字。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofmonth](http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofmonth) + */ + dayOfMonth(dayOfMonthOptions: string): number; + /** + * 返回日期字段对应的天数（一周中的第几天），是一个介于 1（周日）到 7（周六）之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofweek](http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofweek) + */ + dayOfWeek(dayOfWeekOptions: string): number; + /** + * 返回日期字段对应的天数（一年中的第几天），是一个介于 1 到 366 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofyear](http://uniapp.dcloud.io/uniCloud/cf-database?id=dayofyear) + */ + dayOfYear(dayOfYearOptions: string): number; + /** + * 返回日期字段对应的小时数，是一个介于 0 到 23 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=hour](http://uniapp.dcloud.io/uniCloud/cf-database?id=hour) + */ + hour(hourOptions: string): number; + /** + * 返回日期字段对应的 ISO 8601 标准的天数（一周中的第几天），是一个介于 1（周一）到 7（周日）之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isodayofweek](http://uniapp.dcloud.io/uniCloud/cf-database?id=isodayofweek) + */ + isoDayOfWeek(isoDayOfWeekOptions: string): number; + /** + * 返回日期字段对应的 ISO 8601 标准的周数（一年中的第几周），是一个介于 1 到 53 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweek](http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweek) + */ + isoWeek(isoWeekOptions: string): void; + /** + * 返回日期字段对应的 ISO 8601 标准的天数（一年中的第几天）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweekyear](http://uniapp.dcloud.io/uniCloud/cf-database?id=isoweekyear) + */ + isoWeekYear(isoWeekYearOptions: string): number; + /** + * 返回日期字段对应的毫秒数，是一个介于 0 到 999 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=millisecond](http://uniapp.dcloud.io/uniCloud/cf-database?id=millisecond) + */ + millisecond(millisecondOptions: string): number; + /** + * 返回日期字段对应的分钟数，是一个介于 0 到 59 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=minute](http://uniapp.dcloud.io/uniCloud/cf-database?id=minute) + */ + minute(minuteOptions: string): number; + /** + * 返回日期字段对应的月份，是一个介于 1 到 12 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=month](http://uniapp.dcloud.io/uniCloud/cf-database?id=month) + */ + month(monthOptions: string): number; + /** + * 返回日期字段对应的秒数，是一个介于 0 到 59 之间的整数，在特殊情况下（闰秒）可能等于 60。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=second](http://uniapp.dcloud.io/uniCloud/cf-database?id=second) + */ + second(secondOptions: string): number; + /** + * 返回日期字段对应的周数（一年中的第几周），是一个介于 0 到 53 之间的整数。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=week](http://uniapp.dcloud.io/uniCloud/cf-database?id=week) + */ + week(weekOptions: string): number; + /** + * 返回日期字段对应的年份。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=year](http://uniapp.dcloud.io/uniCloud/cf-database?id=year) + */ + year(yearOptions: string): number; + /** + * 直接返回一个值的字面量，不经过任何解析和处理。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=literal](http://uniapp.dcloud.io/uniCloud/cf-database?id=literal) + */ + literal(literalOptions: string): string; + /** + * 输入一个数组，或者数组字段的表达式。如果数组中所有元素均为真值，那么返回 true，否则返回 false。空数组永远返回 true。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=allelementstrue](http://uniapp.dcloud.io/uniCloud/cf-database?id=allelementstrue) + */ + allElementsTrue(allElementsTrueOptions: any[]): boolean; + /** + * 输入一个数组，或者数组字段的表达式。如果数组中任意一个元素为真值，那么返回 true，否则返回 false。空数组永远返回 false。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=anyelementtrue](http://uniapp.dcloud.io/uniCloud/cf-database?id=anyelementtrue) + */ + anyElementTrue(anyElementTrueOptions: any[]): boolean; + /** + * 输入两个集合，输出只存在于第一个集合中的元素。。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setdifference](http://uniapp.dcloud.io/uniCloud/cf-database?id=setdifference) + */ + setDifference(setDifferenceOptions: any[]): any; + /** + * 输入两个集合，判断两个集合中包含的元素是否相同（不考虑顺序、去重）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setequals](http://uniapp.dcloud.io/uniCloud/cf-database?id=setequals) + */ + setEquals(setEqualsOptions: any[]): boolean; + /** + * 输入两个集合，判断两个集合中包含的元素是否相同（不考虑顺序、去重）。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setintersection](http://uniapp.dcloud.io/uniCloud/cf-database?id=setintersection) + */ + setIntersection(setIntersectionOptions: any[]): any; + /** + * 输入两个集合，判断第一个集合是否是第二个集合的子集。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setissubset](http://uniapp.dcloud.io/uniCloud/cf-database?id=setissubset) + */ + setIsSubset(setIsSubsetOptions: any[]): any; + /** + * 输入两个集合，输出两个集合的并集。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=setunion](http://uniapp.dcloud.io/uniCloud/cf-database?id=setunion) + */ + setUnion(setUnionOptions: any[]): any; + /** + * 连接字符串，返回拼接后的字符串。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=concat](http://uniapp.dcloud.io/uniCloud/cf-database?id=concat) + */ + concat(concatOptions: any[]): string; + /** + * 在目标字符串中查找子字符串，并返回第一次出现的 UTF-8 的字节索引（从0开始）。如果不存在子字符串，返回 -1。参数形式为：[目标字符串表达式, 子字符串表达式, 开始位置, + * 结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofbytes](http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofbytes) + */ + indexOfBytes(indexOfBytesOptions: any[]): number; + /** + * 在目标字符串中查找子字符串，并返回第一次出现的 UTF-8 的 code point 索引（从0开始）。如果不存在子字符串，返回 -1。参数形式为：[目标字符串表达式, + * 子字符串表达式, 开始位置, + * 结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofcp](http://uniapp.dcloud.io/uniCloud/cf-database?id=indexofcp) + */ + indexOfCP(indexOfCPOptions: any[]): number; + /** + * 按照分隔符分隔字符串，并且删除分隔符，返回子字符串组成的数组。如果字符串无法找到分隔符进行分隔，返回原字符串作为数组的唯一元素。参数形式为：[字符串,分隔符] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=split](http://uniapp.dcloud.io/uniCloud/cf-database?id=split) + */ + split(splitOptions: string): any[]; + /** + * 计算并返回指定字符串中 utf-8 编码的字节数量。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=strlenbytes](http://uniapp.dcloud.io/uniCloud/cf-database?id=strlenbytes) + */ + strLenBytes(strLenBytesOptions: string): number; + /** + * 计算并返回指定字符串的UTF-8 code points 数量。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=strlencp](http://uniapp.dcloud.io/uniCloud/cf-database?id=strlencp) + */ + strLenCP(strLenCPOptions: string): number; + /** + * 对两个字符串在不区分大小写的情况下进行大小比较，并返回比较的结果。如果第一个值小于第二个值，返回 -1 。如果第一个值大于第二个值，返回 1 。 如果两个值相等，返回 0 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=strcasecmp](http://uniapp.dcloud.io/uniCloud/cf-database?id=strcasecmp) + */ + strcasecmp(strcasecmpOptions: any[]): number; + /** + * 返回字符串从指定位置开始的指定长度的子字符串。它是 db.command.aggregate.substrBytes + * 的别名，更推荐使用后者。参数形式为：[字符串,起始位置,结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=substr](http://uniapp.dcloud.io/uniCloud/cf-database?id=substr) + */ + substr(substrOptions: any[]): string; + /** + * 返回字符串从指定位置开始的指定长度的子字符串。子字符串是由字符串中指定的 UTF-8 字节索引的字符开始，长度为指定的字节数。参数形式为：[字符串,起始位置,结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=substrbytes](http://uniapp.dcloud.io/uniCloud/cf-database?id=substrbytes) + */ + substrBytes(substrBytesOptions: any[]): string; + /** + * 返回字符串从指定位置开始的指定长度的子字符串。子字符串是由字符串中指定的 UTF-8 字节索引的字符开始，长度为指定的字节数。参数形式为：[字符串,起始位置,结束位置] + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=substrcp](http://uniapp.dcloud.io/uniCloud/cf-database?id=substrcp) + */ + substrCP(substrCPOptions: any[]): string; + /** + * 将字符串转化为小写并返回。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=tolower](http://uniapp.dcloud.io/uniCloud/cf-database?id=tolower) + */ + toLower(toLowerOptions: string): string; + /** + * 将字符串转化为大写并返回。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=toupper](http://uniapp.dcloud.io/uniCloud/cf-database?id=toupper) + */ + toUpper(toUpperOptions: string): string; + /** + * 向数组中添加值，如果数组中已存在该值，不执行任何操作。它只能在 group 阶段中使用。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=addtoset](http://uniapp.dcloud.io/uniCloud/cf-database?id=addtoset) + */ + addToSet(addToSetOptions: string): void; + /** + * 返回一组集合中，指定字段对应数据的平均值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=avg](http://uniapp.dcloud.io/uniCloud/cf-database?id=avg) + */ + avg(avgOptions: string): void; + /** + * 返回指定字段在一组集合的第一条记录对应的值。仅当这组集合是按照某种定义排序（ sort ）后，此操作才有意义。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=first](http://uniapp.dcloud.io/uniCloud/cf-database?id=first) + */ + first(firstOptions: string): void; + /** + * 返回指定字段在一组集合的最后一条记录对应的值。仅当这组集合是按照某种定义排序（ sort ）后，此操作才有意义。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=last](http://uniapp.dcloud.io/uniCloud/cf-database?id=last) + */ + last(lastOptions: string): void; + /** + * 返回一组数值的最大值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=max](http://uniapp.dcloud.io/uniCloud/cf-database?id=max) + */ + max(maxOptions: string): void; + /** + * 返回一组数值的最小值。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=min](http://uniapp.dcloud.io/uniCloud/cf-database?id=min) + */ + min(minOptions: string): void; + /** + * 将多个文档合并为单个文档 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=mergeobjects](http://uniapp.dcloud.io/uniCloud/cf-database?id=mergeobjects) + */ + mergeObjects(mergeObjectsOptions: string | any[]): void; + /** + * 在 group 阶段，返回一组中表达式指定列与对应的值，一起组成的数组。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=push-1](http://uniapp.dcloud.io/uniCloud/cf-database?id=push-1) + */ + push(pushOptions: any): void; + /** + * 返回一组字段对应值的标准差。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevpop](http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevpop) + */ + stdDevPop(stdDevPopOptions: string): void; + /** + * 计算输入值的样本标准偏差。如果输入值代表数据总体，或者不概括更多的数据，请改用 db.command.aggregate.stdDevPop 。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevsamp](http://uniapp.dcloud.io/uniCloud/cf-database?id=stddevsamp) + */ + stdDevSamp(stdDevSampOptions: string): void; + /** + * 计算并且返回一组字段所有数值的总和。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=sum](http://uniapp.dcloud.io/uniCloud/cf-database?id=sum) + */ + sum(sumOptions: string): void; + /** + * 自定义变量，并且在指定表达式中使用，返回的结果是表达式的结果。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=let](http://uniapp.dcloud.io/uniCloud/cf-database?id=let) + */ + let(letOptions: LetOptions): void; + } + + interface DateToStringOptions { + /** + * 日期表达式 + */ + date: string; + /** + * 格式化表达式 + */ + format: string; + /** + * 时区表达式，指明运算结果的时区。它可以解析格式为 UTC Offset 或者 Olson Timezone Identifier 的字符串。 + * - Asia/Shanghai: + */ + timezone?: Timezone; + /** + * 空值表达式，可选。当日期表达式返回空或者不存在的时候，会返回此表达式指明的值。 + */ + onNull?: string; + } + + interface DateFromStringOptions { + /** + * 日期字符串 + */ + dateString: string; + /** + * 时区，Olson Timezone Identifier + * - Asia/Shanghai: + */ + timezone?: Timezone; + } + + interface DateFromPartsOptions { + /** + * 年份 + */ + year?: number; + /** + * 月份 + */ + month?: number; + /** + * 日期 + */ + day?: number; + /** + * 小时 + */ + hour?: number; + /** + * 分钟 + */ + minute?: number; + /** + * 秒 + */ + second?: number; + /** + * 毫秒 + */ + millisecond?: number; + /** + * 时区，Olson Timezone Identifier + * - Asia/Shanghai: + */ + timezone?: Timezone; + /** + * ISO标准年份 + */ + isoWeekYear?: number; + /** + * ISO标准一年中的第几周 + */ + isoWeek?: number; + /** + * ISO标准一周中的第几天（周一：0-周日：7） + */ + isoDayOfWeek?: number; + } + + interface LetOptions { + /** + * 定义多个变量，变量的值由 变量表达式 计算而来，并且被定义的变量只有在 in 中的 结果表达式 才可以访问。 + */ + vars: any; + /** + * 结果表达式中访问自定义变量时候，请在变量名前加上双美元符号( $$ )并用引号括起来，如：'$$price' + */ + in: any; + } + + interface SwitchOptions { + /** + * switch操作的分支部分 + */ + branches: BranchedOptions[]; + /** + * switch的默认操作 + */ + default: any; + } + + interface BranchedOptions { + /** + * 判断条件 + */ + case: any; + /** + * 条件为真时执行的操作 + */ + then: any; + } + + interface ZipOptions { + /** + * 一个二维数组（inputs 不可以是字段引用），其中每个元素的表达式（这个可以是字段引用）都可以解析为数组。如果其中任意一个表达式返回 null，inputs 也返回 + * null。如果其中任意一个表达式不是指向一个合法的字段 / 解析为数组 / 解析为 null，则返回错误。 + */ + inputs: any; + /** + * 决定输出数组的长度是否采用输入数组中的最长数组的长度。默认为 false，即输入数组中的最短的数组的长度即是输出数组的各个元素的长度。 + */ + useLongestLength: any; + /** + * 一个数组，用于指定在输入数组长度不一的情况下时采用的数组各元素默认值。指定这个字段则必须指定 useLongestLength，否则返回错误。如果 useLongestLength + * 是 true 但是 + * defaults 是空或没有指定，则 zip 用 null 做数组元素的缺省默认值。指定各元素默认值时 defaults 数组的长度必须是输入数组最大的长度。 + */ + defaults: any; + } + + interface ReduceOptions { + /** + * 输入数组，可以是任意解析为数组的表达式 + */ + input: string | any[]; + /** + * 初始值 + */ + initialValue: string; + /** + * 用来作用于每个元素的表达式，在 in 中有两个可用变量，value 是表示累计值的变量，this 是表示当前数组元素的变量 + */ + in: any; + } + + interface MapOptions { + /** + * 一个可以解析为数组的表达式 + */ + input: string; + /** + * 可选，用于表示数组各个元素的变量，默认为 this + */ + as: string; + /** + * 一个可以应用在给定数组的各个元素上的表达式，各个元素的名字由 as 参数决定（参数名需加 $$ 前缀，如 $$this） + */ + in: any; + } + + interface FilterOptions { + /** + * 一个可以解析为数组的表达式 + */ + input: string; + /** + * 可选，用于表示数组各个元素的变量，默认为 this + */ + as: string; + /** + * 一个可以解析为布尔值的表达式，用于判断各个元素是否满足条件，各个元素的名字由 as 参数决定（参数名需加 $$ 前缀，如 $$this） + */ + cond: boolean; + } + + interface IGeoNearOptions { + /** + * 地理位置点 (Point) + */ + geometry: Point; + /** + * 选填，最大距离，单位为米 + */ + maxDistance: number; + /** + * 选填，最小距离，单位为米 + */ + minDistance: number; + } + + interface IGeoWithinOptions { + /** + * 地理信息结构，Polygon，MultiPolygon，或 { centerSphere } + */ + geometry: any; + } + + interface IGeoIntersectsOptions { + /** + * 地理信息结构，Point + */ + geometry: any; + } + + interface LogicCommand { + fieldName: any; + operator: any; + operands: any; + _internalType: InternalSymbol; + _setFieldName(fieldName: string): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=and](http://uniapp.dcloud.io/uniCloud/cf-database?id=and) + */ + and(__expressions__: any): LogicCommand; + /** + * 查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件。或指令有两种用法，一是可以进行字段值的 “或” 操作，二是也可以进行跨字段的 “或” 操作。 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-database?id=or](http://uniapp.dcloud.io/uniCloud/cf-database?id=or) + */ + or(__expressions__: any): LogicCommand; + } + + interface InternalSymbol { + for(target: any): InternalSymbol; + } + + interface UpdateCommand { + fieldName: any; + operator: UPDATE_COMMANDS_LITERAL; + operands: any; + _internalType: InternalSymbol; + _setFieldName(fieldName: string): UpdateCommand; + } + + interface InterceptorMap { + invoke?: (result: any) => void; + success?: (result: any) => void; + fail?: (result: any) => void; + complete?: (result: any) => void; + } + + interface ChooseAndUploadFileSuccessCallbackResult { + /** + * 错误信息 + */ + errMsg: string; + /** + * 临时文件路径列表 + */ + tempFilePaths: any[]; + /** + * 文件列表，每一项是一个 File 对象 + */ + tempFiles: any[]; + } + + interface ChooseAndUploadFileOnUploadProgressCallbackResult { + /** + * 触发当前上传进度回调的文件序号 + */ + index: number; + /** + * 已上传大小 + */ + loaded: number; + /** + * 总大小 + */ + total: number; + /** + * 临时文件路径 + */ + tempFilePath: string; + /** + * 文件对象 + */ + tempFile: any; + } + + interface ChooseAndUploadFileOnChooseFileCallbackResult { + /** + * 错误信息 + */ + errMsg: string; + /** + * 临时文件路径列表 + */ + tempFilePaths: any[]; + /** + * 文件列表，每一项是一个 File 对象 + */ + tempFiles: any[]; + } + + interface ChooseAndUploadFileOptions { + /** + * 文件类型 + * - image: 图片 + * - video: 视频 + * - all: 任意文件 + */ + type: 'image' | 'video' | 'all'; + /** + * 文件数量 + */ + count?: number; + /** + * 允许的文件后缀数组 + */ + extension?: any[]; + /** + * original 原图，compressed 压缩图，默认二者都有 + */ + sizeType?: string | string[]; + /** + * album 从相册选图，camera 使用相机，默认二者都有 + */ + sourceType?: string | string[]; + /** + * 摄像切换 + * - front: 前置摄像头 + * - back: 后置摄像头 + */ + camera?: 'front' | 'back'; + /** + * 是否压缩所选的视频源文件，默认值为true，需要压缩 + */ + compressed?: boolean; + /** + * 拍摄视频最长拍摄时间，单位秒。最长支持 60 秒 + */ + maxDuration?: number; + /** + * 选择文件后的回调 + */ + onChooseFile?: (result: ChooseAndUploadFileOnChooseFileCallbackResult) => void; + /** + * 上传进度回调 + */ + onUploadProgress?: (result: ChooseAndUploadFileOnUploadProgressCallbackResult) => void; + /** + * 接口调用成功的回调函数 + */ + success?: (result: ChooseAndUploadFileSuccessCallbackResult) => void; + /** + * 接口调用失败的回调函数 + */ + fail?: (result: any) => void; + /** + * 接口调用结束的回调函数（调用成功、失败都会执行） + */ + complete?: (result: any) => void; + } + + interface LocalUserInfo { + /** + * 当前用户uid + */ + uid: string; + /** + * 当前用户角色列表 + */ + role: any[]; + /** + * 当前用户权限列表 + */ + permission: any[]; + } + + interface UniCloudOptions { + /** + * 选择服务供应商 + * - tencent: 选择腾讯云作为服务商 + * - aliyun: 选择阿里云作为服务商 + */ + provider: 'tencent' | 'aliyun'; + /** + * 服务空间ID + */ + spaceId: string; + /** + * 服务空间对应的clientSecret + */ + clientSecret?: string; + /** + * 服务空间地址 + */ + endpoint?: string; + } + + interface UniCloudError { + /** + * 错误码 + */ + errCode: number | string; + /** + * 错误信息 + */ + errMsg: string; + /** + * 返回信息 + */ + message: string; + /** + * 请求id方便排错 + */ + requestId: string; + /** + * 请求id方便排错 + */ + detail: any; + } + + interface UserInfo { + /** + * 用户在uniCloud的唯一ID + */ + uid: string; + /** + * 自定义登录的用户ID + */ + customUserId: string; + } + + interface Auth { + /** + * 任何方式登录成功后，可以调用 getUserInfo 获得用户的身份信息 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/authentication?id=authgetuserinfo](http://uniapp.dcloud.io/uniCloud/authentication?id=authgetuserinfo) + */ + getUserInfo(): UserInfo; + /** + * 开发者可以通过 getLoginState() 来获取当前的登录状态，调用 getLoginState() 后，SDK + * 会识别本地是否有登录状态，如果有，则会尝试刷新登录状态，若刷新登录状态成功，则会返回新的登录状态，否则返回 undefined + * + * 文档: [http://uniapp.dcloud.io/uniCloud/authentication?id=authgetloginstate](http://uniapp.dcloud.io/uniCloud/authentication?id=authgetloginstate) + */ + getLoginState(): void; + /** + * 进行匿名登录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/authentication?id=authsigninanonymously](http://uniapp.dcloud.io/uniCloud/authentication?id=authsigninanonymously) + */ + signInAnonymously(): void; + /** + * 进行自定义登录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/authentication?id=authsigninwithticket](http://uniapp.dcloud.io/uniCloud/authentication?id=authsigninwithticket) + */ + signInWithTicket(): void; + /** + * 进行自定义登录 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/authentication?id=authshouldrefreshaccesstoken](http://uniapp.dcloud.io/uniCloud/authentication?id=authshouldrefreshaccesstoken) + */ + shouldRefreshAccessToken(callback: (result: any) => void): void; + } + + interface GeneralCallbackResult { + /** + * 状态码，操作成功则不返回 + */ + code: string; + /** + * 错误信息 + */ + message: string; + } + + interface CallFunctionResult { + /** + * 云函数执行结果 + */ + result: any; + /** + * 请求序列号，用于错误排查 + */ + requestId?: string; + } + + interface CallFunctionOptions { + /** + * 云函数名 + */ + name: string; + /** + * 传递给云函数的参数 + */ + data?: any; + /** + * 成功返回的回调函数 + */ + success?: (result: CallFunctionResult) => void; + /** + * 失败返回的回调函数 + */ + fail?: (result: any) => void; + /** + * 结束的回调函数（调用成功、失败都会执行 + */ + complete?: (result: CallFunctionResult) => void; + } + + interface OnUploadProgressResult { + /** + * 已上传大小 + */ + loaded: number; + /** + * 上传文件总大小 + */ + total: number; + } + + interface UploadFileResult { + /** + * 文件唯一 ID，用来访问文件，建议存储起来 + */ + fileID: string; + } + + interface UploadFileOptions { + /** + * 文件的绝对路径，包含文件名。例如 foo/bar.jpg、foo/bar/baz.jpg 等 + */ + cloudPath: string; + /** + * 要上传的文件对象 + */ + filePath: string; + /** + * 上传进度回调 + */ + onUploadProgress?: (result: OnUploadProgressResult) => void; + /** + * 成功返回的回调函数 + */ + success?: (result: UploadFileResult) => void; + /** + * 失败返回的回调函数 + */ + fail?: (result: GeneralCallbackResult) => void; + /** + * 结束的回调函数（调用成功、失败都会执行 + */ + complete?: (result: UploadFileResult) => void; + } + + interface DeleteFileItem { + /** + * 云端fileID + */ + fileID: string; + /** + * 状态码，操作成功则不返回 + */ + code: string; + } + + interface DeleteFileResult { + /** + * 要删除的文件 ID 组成的数组 + */ + fileList: DeleteFileItem[]; + } + + interface DeleteFileOptions { + /** + * 文件ID组成的数组 + */ + fileList: any[]; + /** + * 成功返回的回调函数 + */ + success?: (result: DeleteFileResult) => void; + /** + * 失败返回的回调函数 + */ + fail?: (result: GeneralCallbackResult) => void; + /** + * 结束的回调函数（调用成功、失败都会执行 + */ + complete?: (result: DeleteFileResult) => void; + } + + interface GetTempFileURLItem { + /** + * 文件 ID + */ + fileID: string; + /** + * 状态码，操作成功则为 SUCCESS + */ + code: string; + /** + * 文件访问链接 + */ + tempFileURL: string; + } + + interface GetTempFileURLResult { + /** + * 存储下载链接的数组 + */ + fileList: any[]; + } + + interface GetTempFileURLOptions { + /** + * 文件ID组成的数组 + */ + fileList: any[]; + /** + * 成功返回的回调函数 + */ + success?: (result: GetTempFileURLResult) => void; + /** + * 失败返回的回调函数 + */ + fail?: (result: GeneralCallbackResult) => void; + /** + * 结束的回调函数（调用成功、失败都会执行 + */ + complete?: (result: GetTempFileURLResult) => void; + } + + interface ImportObjectLoadingOptions { + /** + * loading界面文字 + */ + text?: string + /** + * loading是否显示透明遮罩 + */ + mask?: boolean + } + + interface ImportObjectErrorOptions { + /** + * 错误提示类型，modal | toast + */ + type?: 'modal' | 'toast' + /** + * 是否显示重试按钮，type为modal时生效 + */ + retry?: boolean + } + + interface ImportObjectOptions { + /** + * 是否移除自动展示的ui + */ + customUI?: boolean; + /** + * loading界面配置 + */ + loadingOptions?: ImportObjectLoadingOptions + /** + * 错误提示配置 + */ + errorOptions?: ImportObjectErrorOptions + } + + interface UniCloudResponseEvent { + type: 'clientdb' | 'cloudobject' | 'cloudfunction', + content: any + } + + interface UniCloudNeedLoginEvent { + errCode: string | number, + errMsg?: string + redirect?: string + } + + interface UniCloudRefreshTokenEvent { + token: string, + tokenExpired: number + } +} + +interface UniCloud { + /** 用于快速开发datacom规范的组件 */ + mixinDatacom: any; + /** + * 服务空间初始化，返回uniCloud实例 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/init](http://uniapp.dcloud.io/uniCloud/init) + */ + init(options: UniCloudClientNamespace.UniCloudOptions): UniCloud; + /** + * 获取登录对象 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/authentication?id=custom-auth](http://uniapp.dcloud.io/uniCloud/authentication?id=custom-auth) + */ + customAuth(): UniCloudClientNamespace.Auth; + /** + * 调用云函数 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cf-functions?id=clientcallfunction](http://uniapp.dcloud.io/uniCloud/cf-functions?id=clientcallfunction) + */ + callFunction(options: UniCloudClientNamespace.CallFunctionOptions): Promise; + /** + * 引用云对象 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/cloud-obj](http://uniapp.dcloud.io/uniCloud/cloud-obj) + */ + importObject(objectName: string, importObjectOptions?: UniCloudClientNamespace.ImportObjectOptions): any; + /** + * 上传文件到云端 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/storage?id=uploadfile](http://uniapp.dcloud.io/uniCloud/storage?id=uploadfile) + */ + uploadFile(options: UniCloudClientNamespace.UploadFileOptions): Promise; + /** + * 选择并上传文件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/storage?id=chooseanduploadfile](http://uniapp.dcloud.io/uniCloud/storage?id=chooseanduploadfile) + */ + chooseAndUploadFile(options: UniCloudClientNamespace.ChooseAndUploadFileOptions): Promise; + /** + * 删除云端文件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/storage?id=deletefile](http://uniapp.dcloud.io/uniCloud/storage?id=deletefile) + */ + deleteFile(options: UniCloudClientNamespace.DeleteFileOptions): Promise; + /** + * 获取文件临时链接 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/storage?id=gettempfileurl](http://uniapp.dcloud.io/uniCloud/storage?id=gettempfileurl) + */ + getTempFileURL(options: UniCloudClientNamespace.GetTempFileURLOptions): Promise; + /** + * 获取数据库实例 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/jql?id=jssdk](http://uniapp.dcloud.io/uniCloud/jql?id=jssdk) + */ + database(options?: UniCloudClientNamespace.UniCloudOptions): UniCloudClientNamespace.Database; + /** + * 获取当前用户缓存在token内的信息 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=client-getcurrentuserinfo](http://uniapp.dcloud.io/uniCloud/client-sdk?id=client-getcurrentuserinfo) + */ + getCurrentUserInfo(): UniCloudClientNamespace.LocalUserInfo; + /** 事件回调 */ + on(eventName: string, callback: (result: any) => void): void; + /** + * 监听云函数、云对象、clientDB的响应 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=on-response](http://uniapp.dcloud.io/uniCloud/client-sdk?id=on-response) + */ + onResponse(callback: (result?: UniCloudClientNamespace.UniCloudResponseEvent) => void): void + /** + * 移除监听云函数、云对象、clientDB的响应 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=off-response](http://uniapp.dcloud.io/uniCloud/client-sdk?id=off-response) + */ + offResponse(callback: (result?: UniCloudClientNamespace.UniCloudResponseEvent) => void): void + /** + * 监听需要登录事件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=on-need-login](http://uniapp.dcloud.io/uniCloud/client-sdk?id=on-need-login) + */ + onNeedLogin(callback: (result?: UniCloudClientNamespace.UniCloudNeedLoginEvent) => void): void + /** + * 移除监听需要登录事件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=off-need-login](http://uniapp.dcloud.io/uniCloud/client-sdk?id=off-need-login) + */ + offNeedLogin(callback: (result?: UniCloudClientNamespace.UniCloudNeedLoginEvent) => void): void + /** + * 监听token刷新事件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=on-refresh-token](http://uniapp.dcloud.io/uniCloud/client-sdk?id=on-refresh-token) + */ + onRefreshToken(callback: (result?: UniCloudClientNamespace.UniCloudRefreshTokenEvent) => void): void + /** + * 移除监听token刷新事件 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=off-refresh-token](http://uniapp.dcloud.io/uniCloud/client-sdk?id=off-refresh-token) + */ + offRefreshToken(callback: (result: UniCloudClientNamespace.UniCloudRefreshTokenEvent) => void): void + /** + * 添加拦截器 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=add-interceptor](http://uniapp.dcloud.io/uniCloud/client-sdk?id=add-interceptor) + */ + addInterceptor(apiName: string, interceptor: (result: any) => void): void; + /** + * 移除拦截器 + * + * 文档: [http://uniapp.dcloud.io/uniCloud/client-sdk?id=remove-interceptor](http://uniapp.dcloud.io/uniCloud/client-sdk?id=remove-interceptor) + */ + removeInterceptor(apiName: string, interceptor?: (result: any) => void): void; +} + +/** + * uniCloud 实例变量 + * + * 文档: [https://uniapp.dcloud.net.cn/uniCloud/](https://uniapp.dcloud.net.cn/uniCloud/) + */ +declare const uniCloud: UniCloud diff --git a/resources/mobile/node_modules/@dcloudio/types/uni-app/common.d.ts b/resources/mobile/node_modules/@dcloudio/types/uni-app/common.d.ts new file mode 100644 index 0000000..d5879c1 --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/uni-app/common.d.ts @@ -0,0 +1,7 @@ +interface AnyObject { + [key: string]: any; +} + +type KVInfer = { [K in keyof T]: T[K] }; + +type Void = T | undefined | null; diff --git a/resources/mobile/node_modules/@dcloudio/types/uni-app/index.d.ts b/resources/mobile/node_modules/@dcloudio/types/uni-app/index.d.ts new file mode 100644 index 0000000..555121d --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/uni-app/index.d.ts @@ -0,0 +1,7 @@ +/// +/// +/// +/// +/// +/// +/// \ No newline at end of file diff --git a/resources/mobile/node_modules/@dcloudio/types/uni-app/page.d.ts b/resources/mobile/node_modules/@dcloudio/types/uni-app/page.d.ts new file mode 100644 index 0000000..a6b830e --- /dev/null +++ b/resources/mobile/node_modules/@dcloudio/types/uni-app/page.d.ts @@ -0,0 +1,244 @@ +declare namespace Page { + interface CustomShareContent { + /** + * 转发标题。默认值：当前应用名称 + */ + title?: string; + /** + * 转发路径，必须是以 / 开头的完整路径。默认值：当前页面 path + */ + path?: string; + /** + * 自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4，默认值：使用默认截图 + */ + imageUrl?: string; + } + + interface ShareTimelineContent { + /** + * 自定义标题。默认值：当前小程序名称 + */ + title?: string; + /** + * 自定义页面路径中携带的参数 + */ + path?: string; + /** + * 自定义图片路径，可以是本地文件或者网络图片。支持 PNG 及 JPG，显示图片长宽比是 1:1。 + */ + imageUrl?: string; + } + + interface PageScrollOption { + /** + * 页面在垂直方向已滚动的距离（单位 px） + */ + scrollTop: number; + } + + interface ShareAppMessageOption { + /** + * 转发事件来源。 + * 可选值： + * - `button`：页面内转发按钮； + * - `menu`：右上角转发菜单。 + */ + from: "button" | "menu"; + /** + * 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined` + */ + target: any; + /** + * 页面中包含 `` 组件时，返回当前 `` 的 url + */ + webViewUrl?: string; + } + + interface AddToFavoritesOption { + /** + * 页面中包含 `` 组件时，返回当前 `` 的 url + */ + webviewUrl: string + } + + interface CustomFavoritesContent { + /** + * 自定义标题，默认值：页面标题或账号名称 + */ + title?: string; + /** + * 自定义 query 字段 + */ + path?: string; + /** + * 自定义图片，显示图片长宽比为 1：1 + */ + imageUrl?: string; + } + + interface TabItemTapOption { + /** + * 被点击 tabItem 的序号，从0开始 + */ + index: string; + /** + * 被点击 tabItem 的页面路径 + */ + pagePath: string; + /** + * 被点击 tabItem 的按钮文字 + */ + text: string; + } + + interface NavigationBarButtonTapOption { + /** + * 原生标题栏按钮数组的下标 + */ + index: string; + } + + interface BackPressOption { + /** + * - backbutton 顶部导航栏左边的返回按钮或 Android 实体返回键 + * - navigateBack 返回 API，即 uni.navigateBack() + */ + from: 'backbutton' | 'navigateBack'; + } + + interface NavigationBarSearchInputEvent { + /** + * 搜索输入框输入内容 + */ + text: string; + } + + interface PageInstanceBaseProps { + /** + * 到当前页面的路径，类型为 `String` + */ + route?: string; + } + + interface PageInstance extends PageInstanceBaseProps { + /** + * 生命周期回调 监听页面初始化 + * + * 页面初始化时触发。一个页面只会调用一次，可以在 onInit 的参数中获取打开当前页面路径中的参数。 + * @param query 打开当前页面路径中的参数 + */ + onInit?(query?: AnyObject): void; + /** + * 生命周期回调 监听页面加载 + * + * 页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。 + * @param query 打开当前页面路径中的参数 + */ + onLoad?(query?: AnyObject): void; + /** + * 生命周期回调 监听页面显示 + * + * 页面显示/切入前台时触发。 + */ + onShow?(): void; + /** + * 生命周期回调 监听页面初次渲染完成 + * + * 页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。 + */ + onReady?(): void; + /** + * 生命周期回调 监听页面隐藏 + * + * 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。 + */ + onHide?(): void; + /** + * 生命周期回调 监听页面卸载 + * + * 页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。 + */ + onUnload?(): void; + /** + * 监听用户下拉动作 + * - 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。 + * - 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 + * - 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。 + */ + onPullDownRefresh?(): void; + /** + * 页面上拉触底事件的处理函数 + * - 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。 + * - 在触发距离内滑动期间，本事件只会被触发一次。 + */ + onReachBottom?(): void; + /** + * 用户点击右上角转发 + * + * 监听用户点击页面内转发按钮（`