聆客开放平台

# 配置项类型

为了使PCLink可定制化,编译平台添加了四种类型的配置项给PCLink:

  • 基本信息
  • 图片配置
  • 功能开关
  • 布局配置

# 基本信息

基本信息是最重要的配置项,目前多数是使用文本替换。

  • 中文名称:应用的中文名称,在Mac上和应用标志构成Mac的唯一标识
  • 英文名称:应用的英文名称,作为应用在Windows上的唯一标识,标识相同,则有覆盖安装行为。
  • 应用标志:应用的标识,只在Mac上有效,格式如Java包名,例如:com.bingo.link。
  • 缓存目录名称:用户个人数据的存放位置的目录名,默认为data就行。
  • 版本编号(升级):定义安装包的版本号,将会被用来判断是否有新版本,值必须为数字
  • 版本名称(显示):用来显示当前安装包的版本号,值必须为d.d.d,例如:1.0.0。
  • 安装包名称:打出的安装包的名字。
  • 手机APP下载路径:登录页处添加引导下载手机APP的入口。(该配置项在4.3.0以上版本已经废弃。)
  • 评论最多字数:允许动态评论最多的字数。
  • 评论最少字数:允许动态评论最少的字数。
  • 动态正文最多字数:用户发表动态时,正文允许写的最多字数。
  • 登录名后缀:配置了登录名的后缀名,可以让用户在登录时帐号不需要填后缀名部分。
  • 检测更新地址:指向一份json文件,文件内包含Windows和Mac最新版本的版本编号、版本名称,更新日志等信息。
  • 找回密码方式:可选择通过密码找回,或通过邮箱找回。
  • 更换中文语言包:可从中文语言包模板中,抽取出想改的部分形成一个新文件,上传到此配置项即可。
  • 更换英文语言包:可从英文语言包模板中,抽取出想改的部分形成一个新文件,上传到此配置项即可。
  • 更换繁体(香港)语言包:可从繁体语言包模板中,抽取出想改的部分形成一个新文件,上传到此配置项即可。语言包资源下载
  • 视频服务提供商:可选声网或anychat。
  • 登录页背景定制:为文件夹替换的配置项,可上传需要定制的登录页背景。登录页背景定制模板下载
  • window安装过程图标:这配置项是一系列windows安装过程的图标,详情可看模板。windows安装过程图标模板下载
  • 默认头像替换:可配置应用中,用户、群组、部门、服务号的默认头像。默认头像模板下载
  • 忘记密码地址:可自定义忘记密码的链接地址,当该项填写时,找回密码方式的配置项无效
  • 帐号注册地址:可自定义帐号注册的链接地址,默认为:https://www.bingolink.biz/default/web_register.html#/。
  • 动态服务地址:后端动态服务接口的地址。(该配置项在4.3.2以上版本已经废弃。)
  • 待办事项地址:当收到待办事项消息时,点击待办事项会话,打开对应填写的地址。
  • 修改密码地址:可自定义修改密码的链接地址,当该项填写时,找回密码方式的配置项无效
  • Copyright字符串:应用的关于页上copyright字段,只在Mac上有效
  • 主面板窗口默认最小宽度:主面板窗口默认最小宽度。
  • 主面板窗口默认最小高度:主面板窗口默认最小高度。
  • 消息通知铃声:更换消息通知铃声。

# 图片配置

图片配置,划分为三个分类,安装图标、托盘图标、应用内图标,相关配置项解析请在图片模板查看。图片模板下载

图片模板下载地址:

  • 应用图标ico(win)
  • 应用图标png(mac)
  • 在线图标(win)
  • 离线图标(win)
  • 在线图标(mac)
  • 离线图标(mac)
  • 新消息图标(mac)
  • 登录页Logo
  • 登录页左侧背景图
  • 登录页右侧背景图
  • 更新界面Logo
  • 卸载界面Logo
  • 聊天窗口背景图

# 功能开关

功能开关,可选择启不启用该项配置。

  • 启动pki登录:有pki功能时才勾选这项,勾选之后登录页将默认显示为pki登录界面。(仅Windows有效)
  • pki的initParam.js:因为存在不同项目组,pki的初始化脚本不同,所以启用pki登录的应用,必须上传该脚本。
  • pki插件下载链接:当检查到本地未安装pki插件时,将自动下载pki插件,地址为此配置项。
  • 启用扫码登录:是否启用登录页的扫码登录功能。
  • 启用忘记密码功能:是否启用忘记密码功能,当不启用时,忘记密码地址和找回密码方式这两配置项无效。
  • 启用注册功能:是否启用注册功能,不启用时,帐号注册地址配置项无效。
  • 启用模拟体验:登录页是否启用模拟体验。(该配置项在4.3.6以上版本已经废弃。)
  • 启用代理设置:登录页是否启用代理设置。
  • 禁止本地保存用户密码:勾选时,将不再保存用户密码。当用户身份失效时,会立刻回到登录页。
  • 启用网盘分享:启用网盘分享。
  • 启用群组公告:启用群组公告,不勾选时,不加载群组公告。
  • 启动视频会议:不勾选时,视频会议的入口会被隐藏,也无法解析他人的视频会议消息。
  • 消息文件双击下载:勾选时,屏蔽预览功能(‘启用文件预览’配置项无效),双击可以直接下载文件。
  • 启用主面板快速发起:快速发起在主面板的左下角位置,不勾选时,将隐藏该入口。
  • 启用文件预览:勾选时,点击文件名称或图标可以打开文件预览窗口。
  • 导航菜单显示文字:勾选时,主面板右侧Tab菜单底部将显示文字名称。
  • 启用用户协议(window安装界面):不勾选时,安装界面隐藏用户协议。
  • 支持多语言:勾选时,安装界面可以选择使用语言环境(仅在Windows可选择),个人设置可修改语言。
  • 启用帮助中心:不勾选时,隐藏Windows托盘右键里的帮助中心菜单或Mac的应用帮助中心菜单。
  • 启用在线客服:不勾选时,隐藏Windows托盘右键里的在线客服菜单或Mac的应用在线客服菜单。
  • 启用设置密码:不勾选时,个人设置的设置密码功能将被隐藏。
  • 首次登录强制修改密码:勾选时,在用户第一次登录Link,将会被强制引导到修改密码页。
  • 互联节点:勾选时,登录时会调用互联节点的接口。
  • 企业信息(云盘地址/UI配置):勾选时,登录时会调用企业信息的接口。
  • 用户请假状态信息:勾选时,登录时会调用用户请假状态信息的接口。
  • 启用发送密级文件:勾选时,聊天窗口的文件选项-增加发送密级文件。
  • 启用腾讯会议:勾选时,主面板左侧菜单出现腾讯会议入口。
  • 启动在线文件传输功能:勾选时,用户会话发送文件默认走在线文件传输。
  • 在线传输文件使用独立入口:勾选时,聊天窗口的文件选项-增加在线传输文件入口。(需要启动在线文件传输功能)
  • 在线文件可以发送给移动端:勾选时,在线文件可以发送给移动端。默认不启用。
  • 登录按钮更换为“登录”文字:勾选时,登录按钮更换为“登录”文字。

# 布局配置

布局配置只有一个主界面布局配置,它是一个json对象,里面包含基础配置和拓展配置两大类,其中基础配置是必需的。

# 模板

以下是最完整的模板,你可能不需要那么多。

{
    'tab' : [{
        'icon' : 'icon-tab-chat_gray',
        'code' : 'Message'
    },{
        'icon' : 'icon-tab-date_main',
        'code' : 'ScheduleTask'
    },{
        'icon' : 'icon-tab-forvar_gray',
        'code' : 'Contact'
    },{
        'code' : 'Disk'
    },{
        'icon' : 'icon-tab-group_gray',
        'code' : 'Dynamic'
    },{
        'icon' : 'icon-tab-app_main',
        'code' : 'App'
    },{
        'code' : 'Home',
        'app_code': 'Baidu',
        'url': 'https://www.baidu.com',
        'title_cn': '首页',
        'title_en': 'HomePage'
    }],
    'Contact' : [{
        'code' : 'Friend'
    },{
        'code' : 'Group'
    },{
        'code' : 'Organization'
    },{
        'code' : 'Department'
    },{
        'code' : 'ServiceNo'
    }],
    'QuickStart' : [{
        'code' : 'QuickStart_AddFriend'
    },{
        'code' : 'QuickStart_Chat'
    },{
        'entityName' : 'ExtendSchedule',
        'code' : 'QuickStart_Schedule'
    },{
        'entityName' : 'ExtendDocument',
        'code' : 'QuickStart_Document'
    },{
        'entityName' : 'ExtendWorktask',
        'code' : 'QuickStart_Worktask'
    },{
        'code' : 'FileTransfer'
    },{
        'code' : 'QuickStart_More'
    }],
    'BlogPublishScopes': [{
        'code': 'Public',
        'isDefaultScope': true
    }, {
        'code': 'Colleague'
    }, {
        'code': 'Friend'
    }, {
        'code': 'Part'
    }],
    'JsInject' : {
        'http://kezida.net' : 'var labelTexts={\'LinkUser\':\'{linkUserName}\',\'LinkUserPhone\':\'{linkUserPhone}\',\'LinkUserOrg\':\'{linkUserOrg}\',\'LinkUserDept\':\'{linkUserDept}\'};var labels=document.getElementsByTagName(\'label\');for(var i=0;i<labels.length;i++){var text=labels[i].innerText.replace(/[^\\w]/,\'\');if(typeof labelTexts[text] !== \'undefined\'){var input=labels[i].nextElementSibling.firstChild;input.value=labelTexts[text];labels[i].parentNode.hidden=\'true\'}};'
    },
    'SkinSetting': {
        'loginShowOverallBg': true,
        'loginInputTextColor': '#45F1FC',
        'loginSpanTextColor':'#B9D7F9',
        'loginIconColor':'#FFFFFF',
        'loginAccountOffsetTop': '28px',
        'loginHideVCodeBorder': true,
        'loginPkiBtnOnlyText': true,
        'themeColor': '#F88E1D',
        'homeMenuBgColor': '#383c3f',
        'homeMenuIconDefaultColor': '#a7a7a9',
        'chatBgColor': '#FFFFFF',
        'chatHeTextBubbleColor': '#F4F4F4',
        'chatMyTextColor' : '#000000',
        'chatMyTextBubbleColor' : '#D7ECFF',
        'liMenuTextColor': '#FF7305',
        'liMenuTextBgColor': '#FFEFEB'
    },
    'ProfileAvatarReplaceUri' : 'http://www.baidu.com/',
    'ReplaceRequestUri': {
        'http://10.201.62.13:8294/': 'http://10.201.62.111:6437/',
        'http://10.201.62.13:8888/': 'http://10.201.62.111:6666'
	}
}

# 一、基础配置

tab、Contact、QuickStart、BlogPublishScopes

# tab

配置主面板左侧Tab的模块,目前内置模块为:

  • Message(消息)
  • ScheduleTask(日程)
  • Contact(通讯录)
  • Disk(云盘)
  • Dynamic(动态)
  • App(应用)
  • Home(首页)为自定义模块,可填写自定义链接。其中code为固定值Home,app_code是做唯一标识。

PS:先后的顺序,由数据的位置决定。

# Contact

配置主面板通讯录里的列表菜单,可选:

  • Friend(好友)
  • Group(群组)
  • Organization(企业)
  • Department(我的部门)
  • ServiceNo(服务号)

PS:Organization这一项比较特殊,当配置中无这项时,所有显示企业组织树的地方将也不会显示。

# QuickStart

配置主面板左下角快速发起的菜单项,可选:

  • QuickStart_AddFriend(添加好友)
  • QuickStart_Chat(发起聊天)
  • QuickStart_Schedule(发起日程)
  • QuickStart_Document(发起文档)
  • QuickStart_Worktask(发起任务)
  • FileTransfer(文件传输助手)
  • QuickStart_More(更多发起)。

# BlogPublishScopes

该项配置动态发表的范围。

  • Public(公开)
  • Colleague(部门)
  • Friend(好友)
  • Part(部分)

PS:isDefaultScope这个属性可以配置默认显示哪一种范围。

# 二、拓展配置

JsInject、SkinSetting、ProfileAvatarReplaceUri、ReplaceRequestUri

# JsInject

这个是配置在打开表单大师、金数据等表单页面时,自动将LinkUser、LinkUserPhone等字段隐藏并填入当前的用户信息。

PS:需要表单页面配合,字段名称一致。

# SkinSetting

皮肤配置,login开头的属性是专门给登录页的。

# login皮肤设置

不定制登录页时,下方属性请勿添加。

  • loginShowOverallBg:登录页背景图使用全图。当为false时,以登录页左/右侧背景图的配置项为准(为了兼容4.3.7以前的版本);当为true时,以全背景图为准。
  • loginInputTextColor:输入框文字、按钮文字的字体颜色。例如:账号/密码字体颜色。
  • loginSpanTextColor:文本按钮的字体颜色。例如:“记住密码”、“自动登录”、“环境检测”、“找回密码”、“注册帐号”、“网络设置”
  • loginIconColor:小图标颜色。例如:底部箭头、窗口关闭图标。
  • loginAccountOffsetTop:帐号密码的输入框整体向下偏移像素。
  • loginHideVCodeBorder:是否隐藏验证码底部的线条。
  • loginPkiBtnOnlyText:pki登录按钮是否只显示纯文本。

# 通用皮肤设置

  • themeColor:主题色。
  • homeMenuBgColor:主面板左侧菜单栏背景色。
  • homeMenuIconDefaultColor:主面板左侧菜单栏图标默认颜色。
  • homeMenuIconActiveColor:主面板左侧菜单栏图标激活颜色。
  • chatBgColor:消息会话的背景色。
  • chatHeTextBubbleColor:消息会话,别人发送的消息的气泡颜色。
  • chatMyTextColor:消息会话,我发送的消息的文字颜色。
  • chatMyTextBubbleColor:消息会话,我发送的消息的气泡颜色。
  • liMenuTextColor:弹出列表菜单,鼠标经过的文字颜色。
  • liMenuTextBgColor:弹出列表菜单,鼠标经过的背景颜色。

# ProfileAvatarReplaceUri

定制点击主面板左上角用户头像,打开的远程页面。

# ReplaceRequestUri

全局替换请求地址,所有的请求和链接页面都会被匹配替换。

'ReplaceRequestUri': {
    'http://10.201.62.13:8294/': 'http://10.201.62.111:6437/',
    'http://10.201.62.13:8888/': 'http://10.201.62.111:6666'
}

例如:

http://10.201.62.13:8294/appapi/v2/es/group/related 的请求地址,会被替换为 http://10.201.62.111:6437/appapi/v2/es/group/related 。