自定义右键菜单

更新: 2017-5-15

功能概述

为企业中的用户提供企业库的文件自定义右键菜单项, 用户点击菜单项后将触发接口调用或打开一个WEB页面, 用户选中的文件信息将会以参数的形式传给接口或WEB页面

设置

管理员可在企业管理后台 - 自定义右键菜单中设置, 具体设置项如下:

设置项 描述
菜单名称 用户在客户端右键可看到的菜单的中文名称
菜单英文名称 英文语言环境下的菜单名称, 如果不设置默认显示中文名称
排序 自定义菜单的显示顺序
调用方式 接口方式弹出窗口方式

如果调用方式是接口方式, 用户在点击菜单项后会自动触发接口调用, 需要指定:

设置项 描述
接口URL 接口的URL地址
接口调用方式 POSTGET
结果反馈 是否需要将接口调用结果反馈给用户

如果是弹出窗口方式, 用户在点击菜单项后将会弹出一个WEB页面, 需要指定:

设置项 描述
页面URL 弹出窗口页面的URL地址

使用流程

  1. 管理员在管理后台设置自定义右键菜单
  2. 用户在库中选中文件,右键点击自定义的菜单项
  3. 如果该菜单是接口方式, 则服务端会调用接口并带上参数
  4. 如果该菜单是弹出窗口方式, 客户端则会弹出对应WEB URL的窗口

接口调用参数

以下是用户点击菜单后, 调用接口或页面URL时带的参数:

参数名称 类型 描述
org_id int 用户操作的库ID
mount_id int 库空间ID
hash string 文件唯一标识
fullpath string 文件完整路径
filehash string 文件内容唯一标识, 如果是文件夹则不会传该参数
filesize int 文件大小, 如果是文件夹则不会传该参数
dateline int unix当前时间戳
sign string 签名

接收端处理流程

  1. 获取参数
  2. 验证签名(签名算法见API规则, 防止用户接口被攻击, 该步骤可忽略)
  3. 调用企业开发API获取库授权, 调用企业开发API获取文件信息(该步骤可忽略)
  4. 处理
  5. 返回处理结果

接口方式调用结果返回

返回结果格式为JSON, 如果成功返回HTTP 200, 失败则返回 HTTP status >= 400

内容如下:

{
    "code": 处理结果代码,
    "message": 处理结果内容, 提示给用户的信息
}

如果处理时间较长, 建议使用队列方式, 不要直接处理, 请求会超时