fstarter 2.10.56 → 2.10.57

package/src/plugins/plugins/README.md

@@ -0,0 +1,560 @@
+# 新壳对接文档
+
+## 1. 简介
+
+本文档为 e行平台各项目对接新壳的统一标准规范，确保各项目在调用壳功能时遵循一致的接口标准。
+
+## 2. 文档说明
+
+### 适用范围
+
+此文档适用于 e行平台所有项目，修改时请各项目同步更新。
+
+### e行项目列表
+vue2
+- **sales-front-project** - 建议书、投保、回执、产品tab yes
+- **app-hasl** - 服务tab、团队tab、客户tab、我的tab(内勤)、入司、荣誉体系、保全项
+- **app2-hasl** - 我的tab(营销员) fstarter
+- **recruit** - 招募系统 yes
+- **oneleinsure** - 线上转保(飞签) fstarter
+- **flysign-h5** - 保全项目(退保等) fstarter
+- **support-analysis-web** - 客户营销分析 node版本12.10.0 yes
+- **wechatsecur** 企微-云账户
+
+vue3
+- **public-h5-editor** - 公共编辑器(客户-生日祝福) node版本20.16.0 
+  这个项目公共服务，nativeUtils.js auth写成0  上传不需要token  注意：在e家中如果auth1 图片无法显示
+
+- **saleslite** 签到
+- **fatarter** 新框架-张晗
+
+- **pc-hasl** - PC端系统
+
+## 3. 快速开始
+
+### 3.1 环境配置
+
+#### 安装依赖
+
+在项目的 package.json 中添加以下依赖：
+
+```json
+{
+  "dependencies": {
+    "vant": "^2.12.0",
+    "axios": "^0.21.0",
+    "pdfh5": "^1.4.7",
+    "jsencrypt": "^3.5.4",
+    "vue-cropper": "^0.5.6"
+    "canvas": "^3.2.0",
+  }
+}
+```
+
+#### 初始化配置
+
+在项目的 main.js 中引入并初始化：
+
+```javascript
+// 引入 Native Bridge
+import NativeBridge from './util/plugins/native-js-sdk.js'
+NativeBridge.init()
+
+// 引入 Native Utils
+import nativeUtils from './util/plugins/nativeUtils'
+Vue.prototype.$native = nativeUtils
+
+如果之后
+import browserUtils from './util/plugins/browserUtils'
+// 获取环境
+// if (utils.getEnv() === 'app') {
+// } else {
+  // 非壳运行此项目的页面,暂时用不到.项目中页面几乎都是app内打开
+  // Vue.prototype.$native = browserUtils
+// }
+```
+
+### 3.2 基础使用示例
+
+```javascript
+// PDF 阅读示例
+this.$native.pdfRead([
+  {
+    url: "https://teststatic.ihasl.com/pages/salessupport/app/iamges/pdf/hastar.pdf",
+    title: "测试文件1"
+  }
+]).then(res => {
+  console.log(res, '------返回-------')
+})
+```
+
+## 4. API 参考
+
+### 4.1 用户信息管理
+
+#### setUserInfo
+
+设置用户信息（登录后调用）
+
+```javascript
+/**
+ * @param {Object} params - 用户信息参数
+ */
+this.$native.setUserInfo(params)
+```
+
+#### getUserInfo
+
+获取用户信息
+
+```javascript
+/**
+ * @returns {Promise<Object>} 用户信息
+ */
+this.$native.getUserInfo().then(userInfo => {
+  console.log(userInfo)
+})
+```
+
+#### clearUserInfo
+
+清空用户信息（退出登录时调用）
+
+```javascript
+this.$native.clearUserInfo()
+```
+
+### 4.2 分享功能
+
+#### share
+
+分享内容
+
+```javascript
+/**
+ * @param {Object} config - 分享配置
+ * @param {string} config.type - 分享类型: webpage|text|image|miniProgram|file
+ * @param {string} config.scene - 分享场景: session|timeline|wxwork|copyurl 需要几个场景传几个 |分割
+ * @param {Object} config.content - 分享内容
+ * @param {string} config.content.title - 标题
+ * @param {string} config.content.description - 描述
+ * @param {string} config.content.webpageUrl - 分享链接
+ * @param {string} config.content.thumb - 缩略图URL
+ */
+this.$native.share({
+  type: 'webpage',
+  scene: 'session',
+  content: {
+    title: '恒安标准人寿',
+    description: '恒安标准人寿官网描述',
+    webpageUrl: 'https://www.hengansl.com/',
+    thumb: ''
+  }
+}).then(res => {
+  console.log(res, '-----分享结果------')
+})
+```
+
+### 4.3 登录认证
+
+#### wechatLogin 
+
+微信登录 返回：appid code
+
+```javascript
+this.$native.wechatLogin().then(result => {
+  console.log('微信登录结果:', result)
+})
+```
+
+### 4.4 系统功能
+
+#### openSystemBrowser
+
+打开系统浏览器
+
+```javascript
+/**
+ * @param {string} url - 要打开的URL
+ */
+this.$native.openSystemBrowser(url)
+```
+
+#### screenshot
+
+截屏功能
+
+```javascript
+this.$native.screenshot().then(imageData => {
+  console.log('截屏数据:', imageData)
+})
+```
+
+#### setScreenOrientation
+
+设置屏幕方向
+
+```javascript
+/**
+ * @param {string} orientation - 屏幕方向
+ */
+this.$native.setScreenOrientation(orientation)
+```
+
+### 4.5 应用间交互
+
+#### launchApp
+
+唤起其他APP
+
+```javascript
+/**
+ * @param {Object} config - 唤起配置
+ */
+this.$native.launchApp(config)
+```
+
+#### setBackInterceptor
+
+返回拦截
+
+```javascript
+/**
+ * @param {Function} interceptor - 拦截器函数
+ */
+this.$native.setBackInterceptor(interceptor)
+```
+
+### 4.6 页面导航
+
+#### redirectTo
+
+页面重定向（壳中跳转人脸识别使用）
+
+```javascript
+/**
+ * @param {string} url - 目标URL
+ */
+this.$native.redirectTo(url)
+```
+
+#### openPage
+
+打开新的 Webview
+
+```javascript
+/**
+ * @param {string} url - 页面URL
+ */
+this.$native.openPage(url)
+```
+
+#### openPageWithShare
+
+跳转页面带分享功能
+
+```javascript
+/**
+ * @param {Object} config - 页面和分享配置
+ */
+this.$native.openPageWithShare(config)
+```
+
+#### closePage
+
+关闭当前 Webview
+
+```javascript
+this.$native.closePage()
+```
+
+#### setNavigationBarVisible
+
+隐藏原生标题栏
+
+```javascript
+/**
+ * @param {boolean} visible - 是否可见
+ */
+this.$native.setNavigationBarVisible(false)
+```
+
+### 4.7 人脸识别
+
+#### goCheckFace
+
+前往人脸识别页面
+
+```javascript
+this.$native.goCheckFace().then(() => {
+  console.log('进入人脸识别')
+})
+```
+
+#### checkFace
+
+检测人脸识别结果
+
+```javascript
+this.$native.checkFace().then(result => {
+  console.log('人脸识别结果:', result)
+})
+```
+
+### 4.8 设备功能
+
+#### scanQRCode
+
+扫码功能
+
+```javascript
+this.$native.scanQRCode().then(result => {
+  console.log('扫码结果:', result)
+})
+```
+
+#### callphone
+
+拨打电话
+
+```javascript
+/**
+ * @param {string} phone - 电话号码
+ */
+this.$native.callphone(phone)
+```
+
+#### sendSMS
+
+发送短信
+
+```javascript
+/**
+ * @param {string} phone - 电话号码
+ * @param {string} content - 短信内容
+ */
+this.$native.sendSMS(phone, content)
+```
+
+#### readContacts
+
+唤起通讯录 返回的是数组 name  phone：是数组 取第0个
+
+```javascript
+this.$native.readContacts().then(contact => {
+  console.log('选择的联系人:', contact)
+  // 返回格式: {name: '', phone: ''}
+})
+```
+
+### 4.9 媒体功能
+
+#### takePhoto
+
+调起壳拍照
+
+```javascript
+this.$native.takePhoto().then(photo => {
+  console.log('拍摄的照片:', photo)
+})
+```
+
+#### chooseImage
+
+调起壳相册
+
+```javascript
+this.$native.chooseImage().then(images => {
+  console.log('选择的图片:', images)
+})
+```
+
+#### takePicture
+
+调起相机和相册
+
+```javascript
+this.$native.takePicture().then(result => {
+  console.log('拍摄/选择结果:', result)
+})
+```
+
+### 4.10 文件处理
+
+#### pdfRead
+
+PDF 阅读（基于 pdfh5）
+
+```javascript
+/**
+ * @param {Array} files - PDF文件列表
+ * @param {string} files[].url - 文件URL
+ * @param {string} files[].title - 文件标题
+ */
+this.$native.pdfRead([
+  {
+    url: "https://example.com/document.pdf",
+    title: "文档标题"
+  }
+]).then(res => {
+  console.log('PDF阅读结果:', res)
+})
+```
+
+### 4.11 数据存储
+
+#### setItem
+
+持久化存储
+
+```javascript
+/**
+ * @param {string} key - 键名
+ * @param {any} value - 值
+ */
+this.$native.setItem('user_token', 'abc123')
+```
+
+#### getItem
+
+获取持久化存储
+
+```javascript
+/**
+ * @param {string} key - 键名
+ * @returns {Promise<any>} 存储的值
+ */
+this.$native.getItem('user_token').then(value => {
+  console.log('获取的值:', value)
+})
+```
+
+#### removeItem
+
+删除持久化存储
+
+```javascript
+/**
+ * @param {string} key - 键名
+ */
+this.$native.removeItem('user_token')
+```
+
+### 4.12 工具功能
+
+#### Toast
+
+Toast 提示（基于 Vant）
+
+```javascript
+/**
+ * @param {string} message - 提示消息
+ */
+this.$native.Toast('操作成功')
+```
+
+#### addCalendarEvent
+
+添加日历事件
+
+```javascript
+/**
+ * @param {Object} event - 事件信息
+ */
+this.$native.addCalendarEvent({
+  title: '会议',
+  startTime: '2024-01-01 10:00',
+  endTime: '2024-01-01 11:00'
+})
+```
+
+#### encrypt
+
+数据加密（基于 jsencrypt）
+
+```javascript
+/**
+ * @param {string} str - 要加密的字符串
+ * @returns {Promise<string>} 加密结果
+ */
+this.$native.encrypt('敏感数据').then(encrypted => {
+  console.log('加密结果:', encrypted)
+})
+```
+
+### 4.13 位置服务
+
+#### getLocation
+
+获取位置信息
+
+```javascript
+/**
+ * 使用腾讯地图服务
+ * Key: 2WKBZ-DGUWW-MUPR4-3B3F5-ZZJ57-EEBZV
+ * 说明: 曲畅个人账号，已完成恒安企业认证
+ */
+this.$native.getLocation().then(location => {
+  console.log('位置信息:', location)
+})
+```
+
+### 4.14 缓存管理
+
+#### getCacheSize
+
+获取缓存大小
+
+```javascript
+this.$native.getCacheSize().then(size => {
+  console.log('缓存大小:', size)
+})
+```
+
+#### clearCache
+
+清除缓存
+
+```javascript
+this.$native.clearCache().then(() => {
+  console.log('缓存清除成功')
+})
+```
+
+#### getDeviceInfo
+
+获取设备信息
+
+```javascript
+this.$native.getDeviceInfo().then(deviceInfo => {
+  console.log('设备信息:', deviceInfo)
+  {"osName":"iOS",
+  "StartTime":"2025-10-22 15:05:39",
+  "packageInfo":"com.hasl.chome--1.2.0",
+  "brand":"Apple",
+  "osVersion":"15.6",
+  "screen":{"width":375,"orientation":"portrait","statusBarHeight":44,"height":812},"deviceId":"BDCBB513-DF26-4DD2-B36E-03C2C228F4D4",
+  "networkType":"wifi",
+  "isp":"wifi",
+  "ip":"10.14.100.102",
+  "timezone":"Asia\/Shanghai",
+  "appVersion":"1.2.0",
+  "model":"iPhone X"}}}
+})
+```
+
+## 5. 注意事项
+
+- **统一标准**: 所有项目必须遵循此文档规范进行壳功能调用
+- **同步更新**: 文档修改时，各项目需要同步更新对应实现
+- **错误处理**: 所有 API 调用都需要添加适当的错误处理
+- **权限申请**: 部分功能需要用户授权，请确保在调用前处理权限逻辑
+
+## 6. 技术支持
+
+如遇问题，请联系技术团队或参考各项目的具体实现示例。
+
+---
+
+**文档版本**: v1.0  
+**最后更新**: 2025年10月  项语晴