1.0.1 • Published 2 years ago

uftbcapi v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

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

Variables

Functions

Type Aliases

Broadcast

Ƭ Broadcast: Object

广播类型

Type declaration

NameTypeDescription
broadcastContentstring广播内容
enabledboolean是否可用
expireTimestring时效
idstring广播id
maxTrystring拨打次数
tagstring广播标记
usernamestring用户名

BroadcastList

Ƭ BroadcastList: Broadcast[]

广播列表类型 Broadcast[]


Group

Ƭ Group: Object

播报组类型

Type declaration

NameTypeDescription
groupNamestring播报组名称
idstring播报组id

GroupList

Ƭ GroupList: Group[]

广播列表类型Group[]


GroupMember

Ƭ GroupMember: Object

播报组成员类型

Type declaration

NameTypeDescription
confirmDonenumber确认收到
confirmToPlaynumber确认播放
idGroupstring播报组id
memberNamestring成员名
memberNumberstring成员号码
repeatTimesnumber通知次数

GroupMemberListResult

Ƭ GroupMemberListResult: Object

播报组成员列表分页类型

Type declaration

NameTypeDescription
itemsGroupMember[]播报组成员数组
totalnumber总数

GroupPlay

Ƭ GroupPlay: Object

广播播报类型

Type declaration

NameTypeDescription
broadcastIdstring广播模板id
expireTimenumber时效
groupIdstring播报组id
maxTrynumber拨打次数

MemberCfg

Ƭ MemberCfg: Object

任务成员类型

Type declaration

NameTypeDescription
idTaskstring任务id
memberNamestring成员名
memberNumberstring成员号码

MemberListResult

Ƭ MemberListResult: Object

任务成员列表类型

Type declaration

NameTypeDescription
itemsMemberCfg[]成员数组
totalnumber总数

Session

Ƭ Session: Object

会话状态类型

Type declaration

NameTypeDescription
accstring账户
administatorboolean是否管理员
logonboolean是否登录
messagestring信息
usernamestring用户名称

Task

Ƭ Task: Object

广播任务类型

Type declaration

NameTypeDescription
broadcastContentstring广播内容
enabledboolean是否可用
expireTimenumber时效
idstring任务id
maxTrystring拨打次数
tagstring任务标签
usernamestring用户名

TaskList

Ƭ TaskList: Task[]

任务列表类型


UserCfg

Ƭ UserCfg: Object

用户类型

Type declaration

NameTypeDescription
administratorboolean是否管理员
bizCode?string识别码
createTime?Date创建时间
enabledboolean是否可用
idstring用户id
namestring用户名
tagstring标签

Variables

default

Const default: Session

会话状态对象

Functions

bcAdd

bcAdd(bcDate): Promise<any>

广播新增

Parameters

NameTypeDescription
bcDateBroadcast广播数据

Returns

Promise<any>

广播id


bcDel

bcDel(id): Promise<any>

广播删除

Parameters

NameTypeDescription
idstring广播id

Returns

Promise<any>

广播id


bcDetail

bcDetail(id): Promise<any>

广播详情

Parameters

NameTypeDescription
idstring广播id

Returns

Promise<any>

广播内容


bcList

bcList(): Promise<any>

广播列表

Returns

Promise<any>

广播列表数据


bcUpdate

bcUpdate(bcDate): Promise<any>

广播修改

Parameters

NameTypeDescription
bcDateBroadcast广播数据

Returns

Promise<any>

广播id


groupAdd

groupAdd(groupDate): Promise<any>

播报组新增

Parameters

NameTypeDescription
groupDateGroup播报组数据

Returns

Promise<any>

播报组id


groupDel

groupDel(id): Promise<any>

播报组删除

Parameters

NameTypeDescription
idstring播报组id

Returns

Promise<any>

播报组id


groupDetail

groupDetail(id): Promise<any>

播报组详情

Parameters

NameTypeDescription
idstring播报组id

Returns

Promise<any>

播报组数据


groupList

groupList(): Promise<any>

播报组列表

Returns

Promise<any>

播报组数据


groupMemberAdd

groupMemberAdd(groupMemberDate): Promise<any>

播报组人员新增

Parameters

NameTypeDescription
groupMemberDateGroupMember播报组人员数据

Returns

Promise<any>

播报组人员id


groupMemberDel

groupMemberDel(id): Promise<any>

播报组人员删除

Parameters

NameTypeDescription
idstring播报组人员id

Returns

Promise<any>

会议结果


groupMemberList

groupMemberList(bcId): Promise<any>

播报组人员列表

Parameters

NameTypeDescription
bcIdstring播报组id

Returns

Promise<any>

播报组人员列表数据


groupPlay

groupPlay(playForm): Promise<any>

播报组播放

Parameters

NameTypeDescription
playFormGroupPlay播报组广播数据

Returns

Promise<any>

广播任务id


groupUpdate

groupUpdate(groupDate): Promise<any>

播报组更新

Parameters

NameTypeDescription
groupDateGroup播报组数据

Returns

Promise<any>

播报组id


keepalive

keepalive(): Promise<void>

会话心跳保持

Returns

Promise<void>


login

login(url, acc, password): Promise<void>

登录服务器后台

Parameters

NameTypeDescription
urlstring服务器地址
accstring登录账号
passwordstring登录密码

Returns

Promise<void>

在sessState中设置状态


logout

logout(): Promise<void>

退出

Returns

Promise<void>


memberAdd

memberAdd(memberDate): Promise<any>

广播任务人员新增

Parameters

NameTypeDescription
memberDateMemberCfg广播任务人员数据

Returns

Promise<any>

广播任务人员id


memberList

memberList(bcId): Promise<any>

广播任务人员列表

Parameters

NameTypeDescription
bcIdstring广播任务id

Returns

Promise<any>

广播任务人员列表数据


taskAdd

taskAdd(bcDate): Promise<any>

广播任务新增

Parameters

NameTypeDescription
bcDateTask广播任务数据

Returns

Promise<any>

广播任务id


taskDel

taskDel(id): Promise<any>

广播任务删除

Parameters

NameTypeDescription
idstring广播任务id

Returns

Promise<any>

广播任务id


taskDetail

taskDetail(id): Promise<any>

广播任务详情

Parameters

NameTypeDescription
idstring广播任务id

Returns

Promise<any>

广播任务数据


taskList

taskList(): Promise<any>

广播任务列表

Returns

Promise<any>

广播任务列表数据


taskPlay

taskPlay(bcId): Promise<any>

播放广播

Parameters

NameTypeDescription
bcIdstring广播任务id

Returns

Promise<any>

会话结果


taskUpdate

taskUpdate(bcDate): Promise<any>

广播任务更新

Parameters

NameTypeDescription
bcDateTask广播任务数据

Returns

Promise<any>

广播任务id


userSetPassword

userSetPassword(oldPass, newPass): Promise<any>

修改密码

Parameters

NameTypeDescription
oldPassstring老密码
newPassstring新密码

Returns

Promise<any>

会话结果

Modules

Namespace: bcManagetest

testnamespace