致信3客户端开发文档

# 文件操作相关

方法说明中并非所有的方法都会写在文档中，具体请前往相关文件查看代码逻辑。

# 文件位置

TIP

文件位于 public\static\client\client_pc\file.js

# 接口及说明

# getMAC()

获取 MAC 地址

# openFile(path)

打开文件

# openFileInFolder(path)

打开文件所在位置

  • path 文件路径

# fileIsExist(path, callback)

判断文件是否存在-异步

  • path 文件路径
  • callback 回调

# fileExistState(path, callback)

判断文件是否存在-同步

# getOAMsgSort(callback)

获取 OA 消息的排序方式

  • callback 回调

# setOAMsgSort(sortFlag)

设置 OA 消息的排序方式

  • sortFlag 排序规则，具体见 WEB 端传什么参数

# getLanguage()

获取当前语言

返回

  • zh-CN
  • en-US
  • zh-TW

# getSystem(callback)

获取登录配置信息

  • callback 回调

# setSystem(data, callback)

设置登录配置信息

  • data 设置信息
  • callback 回调

# getProxyData(callback)

获取代理信息

  • callback 回调

# setProxyData(val, callback)

设置代理信息

  • val 设置
  • callback 回调

# getSettings(userId, callback)

获取设置

  • userId 用户的 id
  • callback 回调

# saveSettings(data, callback)

保存设置

  • data 设置信息
  • callback 回调

# newSaveSettings(data, callback)

加入自动登录后配置信息

  • data 设置信息
  • callback 回调

# getVersion(callback)

获取版本信息

  • callback 回调

# deleteSystem(ip, callback)

删除 ip 地址

  • callback 回调

# setBgTimeStamp(timeStampType, bgImage, callback)

设置时间戳

  • data 设置信息
  • callback 回调

# getBgTimeStamp(callback)

获取时间戳

  • callback 回调

# setJSESSIONID(data)

设置 JSESSIONID

  • data JSESSIONID 的值

# setROUTE(data)

设置 ROUTE

  • data ROUTE 的值

# getJSESSIONID()

获取 JSESSIONID

# getROUTE()

获取 ROUTE

# uploadFiles(filePath, uploadUrl, uploadFormDataName, headers, msgid, callback)

上传文件

  • filePath 文件的路径
  • uploadUrl 上传地址
  • uploadFormDataName 表单名 目前是 file
  • headers 自定义的headers
  • msgid 消息ID
  • callback 回调

# canelUploadFiles(msgid)

取消上传

  • msgid 消息ID

# setUserInfo(data, callback)

设置登录信息-用户密码等

  • data 设置信息
  • callback 回调

# deleteUser(name, callback)

删除用户

  • name 用户名
  • callback 回调

# getGroupNotice(callback)

群消息屏蔽获取

  • callback 回调

# setGroupNotice(groupId, value, callback)

群消息屏蔽设置

  • groupId 群组ID
  • value 设置值
  • callback 回调

# getGroupFileState(fileId)

获取群文件状态

  • fileId 文件ID

# setGroupFileState(fileId, path, callback)

设置群文件状态

  • fileId 群组ID
  • path 设置值
  • callback 回调

# previewImg(url, type, imgData)

打开图片查看器

  • url 图片查看器地址 老版本用 新版本不用传也可以 只是NW需要
  • type 类型 老版本用 新版本不用传也可以 只是NW需要
  • imgData 图片信息

# selectFolder(callback)

选择文件夹

  • callback 文件夹路径回调

# getFolderInfo(dirPath, option, callback)

获取文件夹信息

  • dirPath 文件夹路径
  • option 设置值 { maxNum: 666, maxsize: 1048576000 } 最大文件个数 做大文件总大小
  • callback 回调

# tarFolder(folderPath, callback)

压缩文件夹

  • folderPath 文件夹路径
  • callback 回调

# removeFolder(folderPath, callback)

移除文件夹

  • folderPath 文件夹路径
  • callback 回调

# untarFolder(untarFilePath, untarFolderPath, callback)

解压文件夹

  • untarFilePath 解压文件路径
  • untarFolderPath 解压到哪个文件夹
  • callback 回调

# addFileNameIncrement(folderPath, callback)

自动重命名，比如文件 文件(1) 文件(2) 文件(3)

  • folderPath 文件路径
  • callback 回调返回文件名

# getSavePathByUserId(folderPath)

读取设置文件，通过用户ID拿到用户设置的下载文件夹

  • folderPath 文件路径

# pathResolve(...paths)

路径拼接

  • 参考path.resolve()

# fileSaveAs()

# defineLogs(params)

自定义日志

  • params {name:"日志名", path:"日志路径"}

可以参考WEB端 src\control\message\messageRecive.js 的代码


let RYMessagesLog = ZX_CLIENT.defineLogs({
  name: userId + ".log",
  path: "RYMessagesLog",
});

let OACardMsgLog = ZX_CLIENT.defineLogs({
  name: userId + ".log",
  path: "OACardMsgLog",
});

RYMessagesLog("### 收到新融云消息 ###", message)
OACardMsgLog('******收到消息卡片《'+message.content.content+'》的消息******',message)

这时候文件夹 %AppData%\Roaming\ZhiXin\Logs\当前日期 中会出现2个名称为 OACardMsgLog RYMessagesLog 的文件夹，文件夹下有 {用户ID}.log 的日志文件。

# clearLogs()

清除日志，清除5天前的日志

← 数据库操作相关 →