VWED_server/docs/sc/手持端相关.md

111 lines
3.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 手持端相关
#### 通知手持端(工位/岗位)
* 方法说明
可以给手持端的指定工位或者岗位发送弹框通知。该弹框可以人工确认。如无人工确认,可配置保持时间,超过保持时间,弹框自动消失。
```
function noticeOperator(workTypes: string, workStations: string, content: string, needConfirm: boolean, keepTime: number): void
```
* 输入参数
* workTypesstring 类型,要通知的岗位。多岗位间逗号分隔。
* workStationsstring 类型,要通知的工位。多工位间逗号分隔。
* contentstring 类型,通知的内容。
* needConfirmboolean类型表示是否需要手持端用户点击确认后通知弹框才会消失。
* keepTimenumber类型表示通知弹框在手持端的保持时间单位秒超过这个时间弹框将消失。
**注意**:本方法采用异步的方式发送群发通知。
* 输出参数
本方法输出参数为空。
* 异常
本方法抛出异常。
#### 通知手持端用户
* 方法说明
可以给手持端的指定用户发送弹框通知。该弹框可以人工确认。如无人工确认,可配置保持时间,超过保持时间,弹框自动消失。
```
function noticeOperatorByUser(userNames: string, content: string, needConfirm: boolean, keepTime: number): void
```
* 输入参数
* userNamesstring 类型,要通知的用户。多用户间逗号分隔。
* contentstring 类型,通知的内容。
* needConfirmboolean类型表示是否需要手持端用户点击确认后通知弹框才会消失。
* keepTimenumber类型表示通知弹框在手持端的保持时间单位秒超过这个时间弹框将消失。
**注意**:本方法采用异步的方式发送群发通知。
* 输出参数
本方法输出参数为空。
* 异常
本方法抛出异常。
#### 通过menuId修改手持端按钮的label
* 方法说明
通过menuId定位修改手持端对应按钮的label(重启之后会失效,恢复到初始状态)
```
function setPadLabelByMenuId(menuId: String, label: String):void
```
* 输入参数
* menuIdstring 类型要更改的手持端任务按钮的menuId
* labelstring 类型将手持端按钮上标签的内容修改为label中的内容
* 输出参数
本方法输出参数为空。
* 异常
本方法抛出异常。
#### 通过menuId修改手持端按钮的背景色
* 方法说明
通过menuId修改手持端按钮的背景色(重启之后会失效,恢复到初始状态)
```
function setPadBackgroundByMenuId(menuId: String, background: String):void
```
* 输入参数
* menuIdstring 类型要更改的手持端任务按钮的menuId
* backgroundstring 类型将手持端按钮上标签的背景色修改为background中的颜色16进制的RGB格式
* 输出参数
本方法输出参数为空。
* 异常
本方法抛出异常。
#### 通过menuId设置手持端按钮是否禁用
* 方法说明
通过menuId设置手持端按钮是否禁用(重启之后会失效,恢复到初始状态)
```
function setPadDisableByMenuId(menuId: String, disable: boolean):void
```
* 输入参数
* menuIdstring 类型要更改的手持端任务按钮的menuId
* disable布尔类型手持端按钮是否设置为禁用
* 输出参数
本方法输出参数为空。
* 异常
本方法抛出异常。