uftbcapi v1.0.1
Enums
Enumeration: ObjectType
功能块名称
Table of contents
Enumeration Members
Enumeration Members
BroadCast
• BroadCast = "bc"
广播模板
Group
• Group = "group"
播报组
GroupMember
• GroupMember = "groupMember"
播报组成员
Member
• Member = "member"
播报记录成员
Task
• Task = "task"
播报记录
User
• User = "user"
用户
Enumeration: Operation
用户操作状态
Table of contents
Enumeration Members
Enumeration Members
Disable
• Disable = "Disable"
禁用
Enable
• Enable = "Enable"
启用
Remove
• Remove = "Remove"
删除
Reset
• Reset = "Reset"
重置
uftbcapi
Table of contents
Namespaces
Enumerations
Type Aliases
- Broadcast
- BroadcastList
- Group
- GroupList
- GroupMember
- GroupMemberListResult
- GroupPlay
- MemberCfg
- MemberListResult
- Session
- Task
- TaskList
- UserCfg
Variables
Functions
- bcAdd
- bcDel
- bcDetail
- bcList
- bcUpdate
- groupAdd
- groupDel
- groupDetail
- groupList
- groupMemberAdd
- groupMemberDel
- groupMemberList
- groupPlay
- groupUpdate
- keepalive
- login
- logout
- memberAdd
- memberList
- taskAdd
- taskDel
- taskDetail
- taskList
- taskPlay
- taskUpdate
- userSetPassword
Type Aliases
Broadcast
Ƭ Broadcast: Object
广播类型
Type declaration
Name | Type | Description |
---|---|---|
broadcastContent | string | 广播内容 |
enabled | boolean | 是否可用 |
expireTime | string | 时效 |
id | string | 广播id |
maxTry | string | 拨打次数 |
tag | string | 广播标记 |
username | string | 用户名 |
BroadcastList
Ƭ BroadcastList: Broadcast
[]
广播列表类型 Broadcast[]
Group
Ƭ Group: Object
播报组类型
Type declaration
Name | Type | Description |
---|---|---|
groupName | string | 播报组名称 |
id | string | 播报组id |
GroupList
Ƭ GroupList: Group
[]
广播列表类型Group[]
GroupMember
Ƭ GroupMember: Object
播报组成员类型
Type declaration
Name | Type | Description |
---|---|---|
confirmDone | number | 确认收到 |
confirmToPlay | number | 确认播放 |
idGroup | string | 播报组id |
memberName | string | 成员名 |
memberNumber | string | 成员号码 |
repeatTimes | number | 通知次数 |
GroupMemberListResult
Ƭ GroupMemberListResult: Object
播报组成员列表分页类型
Type declaration
Name | Type | Description |
---|---|---|
items | GroupMember [] | 播报组成员数组 |
total | number | 总数 |
GroupPlay
Ƭ GroupPlay: Object
广播播报类型
Type declaration
Name | Type | Description |
---|---|---|
broadcastId | string | 广播模板id |
expireTime | number | 时效 |
groupId | string | 播报组id |
maxTry | number | 拨打次数 |
MemberCfg
Ƭ MemberCfg: Object
任务成员类型
Type declaration
Name | Type | Description |
---|---|---|
idTask | string | 任务id |
memberName | string | 成员名 |
memberNumber | string | 成员号码 |
MemberListResult
Ƭ MemberListResult: Object
任务成员列表类型
Type declaration
Name | Type | Description |
---|---|---|
items | MemberCfg [] | 成员数组 |
total | number | 总数 |
Session
Ƭ Session: Object
会话状态类型
Type declaration
Name | Type | Description |
---|---|---|
acc | string | 账户 |
administator | boolean | 是否管理员 |
logon | boolean | 是否登录 |
message | string | 信息 |
username | string | 用户名称 |
Task
Ƭ Task: Object
广播任务类型
Type declaration
Name | Type | Description |
---|---|---|
broadcastContent | string | 广播内容 |
enabled | boolean | 是否可用 |
expireTime | number | 时效 |
id | string | 任务id |
maxTry | string | 拨打次数 |
tag | string | 任务标签 |
username | string | 用户名 |
TaskList
Ƭ TaskList: Task
[]
任务列表类型
UserCfg
Ƭ UserCfg: Object
用户类型
Type declaration
Name | Type | Description |
---|---|---|
administrator | boolean | 是否管理员 |
bizCode? | string | 识别码 |
createTime? | Date | 创建时间 |
enabled | boolean | 是否可用 |
id | string | 用户id |
name | string | 用户名 |
tag | string | 标签 |
Variables
default
• Const
default: Session
会话状态对象
Functions
bcAdd
▸ bcAdd(bcDate
): Promise
<any
>
广播新增
Parameters
Name | Type | Description |
---|---|---|
bcDate | Broadcast | 广播数据 |
Returns
Promise
<any
>
广播id
bcDel
▸ bcDel(id
): Promise
<any
>
广播删除
Parameters
Name | Type | Description |
---|---|---|
id | string | 广播id |
Returns
Promise
<any
>
广播id
bcDetail
▸ bcDetail(id
): Promise
<any
>
广播详情
Parameters
Name | Type | Description |
---|---|---|
id | string | 广播id |
Returns
Promise
<any
>
广播内容
bcList
▸ bcList(): Promise
<any
>
广播列表
Returns
Promise
<any
>
广播列表数据
bcUpdate
▸ bcUpdate(bcDate
): Promise
<any
>
广播修改
Parameters
Name | Type | Description |
---|---|---|
bcDate | Broadcast | 广播数据 |
Returns
Promise
<any
>
广播id
groupAdd
▸ groupAdd(groupDate
): Promise
<any
>
播报组新增
Parameters
Name | Type | Description |
---|---|---|
groupDate | Group | 播报组数据 |
Returns
Promise
<any
>
播报组id
groupDel
▸ groupDel(id
): Promise
<any
>
播报组删除
Parameters
Name | Type | Description |
---|---|---|
id | string | 播报组id |
Returns
Promise
<any
>
播报组id
groupDetail
▸ groupDetail(id
): Promise
<any
>
播报组详情
Parameters
Name | Type | Description |
---|---|---|
id | string | 播报组id |
Returns
Promise
<any
>
播报组数据
groupList
▸ groupList(): Promise
<any
>
播报组列表
Returns
Promise
<any
>
播报组数据
groupMemberAdd
▸ groupMemberAdd(groupMemberDate
): Promise
<any
>
播报组人员新增
Parameters
Name | Type | Description |
---|---|---|
groupMemberDate | GroupMember | 播报组人员数据 |
Returns
Promise
<any
>
播报组人员id
groupMemberDel
▸ groupMemberDel(id
): Promise
<any
>
播报组人员删除
Parameters
Name | Type | Description |
---|---|---|
id | string | 播报组人员id |
Returns
Promise
<any
>
会议结果
groupMemberList
▸ groupMemberList(bcId
): Promise
<any
>
播报组人员列表
Parameters
Name | Type | Description |
---|---|---|
bcId | string | 播报组id |
Returns
Promise
<any
>
播报组人员列表数据
groupPlay
▸ groupPlay(playForm
): Promise
<any
>
播报组播放
Parameters
Name | Type | Description |
---|---|---|
playForm | GroupPlay | 播报组广播数据 |
Returns
Promise
<any
>
广播任务id
groupUpdate
▸ groupUpdate(groupDate
): Promise
<any
>
播报组更新
Parameters
Name | Type | Description |
---|---|---|
groupDate | Group | 播报组数据 |
Returns
Promise
<any
>
播报组id
keepalive
▸ keepalive(): Promise
<void
>
会话心跳保持
Returns
Promise
<void
>
无
login
▸ login(url
, acc
, password
): Promise
<void
>
登录服务器后台
Parameters
Name | Type | Description |
---|---|---|
url | string | 服务器地址 |
acc | string | 登录账号 |
password | string | 登录密码 |
Returns
Promise
<void
>
在sessState中设置状态
logout
▸ logout(): Promise
<void
>
退出
Returns
Promise
<void
>
无
memberAdd
▸ memberAdd(memberDate
): Promise
<any
>
广播任务人员新增
Parameters
Name | Type | Description |
---|---|---|
memberDate | MemberCfg | 广播任务人员数据 |
Returns
Promise
<any
>
广播任务人员id
memberList
▸ memberList(bcId
): Promise
<any
>
广播任务人员列表
Parameters
Name | Type | Description |
---|---|---|
bcId | string | 广播任务id |
Returns
Promise
<any
>
广播任务人员列表数据
taskAdd
▸ taskAdd(bcDate
): Promise
<any
>
广播任务新增
Parameters
Name | Type | Description |
---|---|---|
bcDate | Task | 广播任务数据 |
Returns
Promise
<any
>
广播任务id
taskDel
▸ taskDel(id
): Promise
<any
>
广播任务删除
Parameters
Name | Type | Description |
---|---|---|
id | string | 广播任务id |
Returns
Promise
<any
>
广播任务id
taskDetail
▸ taskDetail(id
): Promise
<any
>
广播任务详情
Parameters
Name | Type | Description |
---|---|---|
id | string | 广播任务id |
Returns
Promise
<any
>
广播任务数据
taskList
▸ taskList(): Promise
<any
>
广播任务列表
Returns
Promise
<any
>
广播任务列表数据
taskPlay
▸ taskPlay(bcId
): Promise
<any
>
播放广播
Parameters
Name | Type | Description |
---|---|---|
bcId | string | 广播任务id |
Returns
Promise
<any
>
会话结果
taskUpdate
▸ taskUpdate(bcDate
): Promise
<any
>
广播任务更新
Parameters
Name | Type | Description |
---|---|---|
bcDate | Task | 广播任务数据 |
Returns
Promise
<any
>
广播任务id
userSetPassword
▸ userSetPassword(oldPass
, newPass
): Promise
<any
>
修改密码
Parameters
Name | Type | Description |
---|---|---|
oldPass | string | 老密码 |
newPass | string | 新密码 |
Returns
Promise
<any
>
会话结果
Modules
Namespace: bcManagetest
testnamespace
2 years ago