1.0.3 • Published 3 years ago

ufimsadmapi v1.0.3

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

Classes

Class: IMSAdmAgent

消息服务器后台管理客户端代理接口封装对象

Table of contents

Constructors

Methods

Constructors

constructor

• new IMSAdmAgent(server, ssl, onSessionStateUpdate, sess?)

构造函数

Parameters
NameTypeDescription
serverstring服务器地址:端口
sslboolean是否采用https协议
onSessionStateUpdate(up: boolean, err?: string) => void会话状态更新回调函数
sess?Session可选共享会话对象(统一认证用)

Methods

chatGroupAdd

▸ chatGroupAdd(config): Promise<number>

新建群聊组

Parameters
NameTypeDescription
configChatGroup群聊组配置参数 ChatGroup
Returns

Promise<number>

群聊组ID

chatGroupDel

▸ chatGroupDel(ids): Promise<void>

删除群聊组

Parameters
NameTypeDescription
idsnumber[]群聊组ID列表
Returns

Promise<void>

chatGroupIdByName

▸ chatGroupIdByName(name): Promise<number>

群聊组名称转换为ID

Parameters
NameTypeDescription
namestring群聊组名称
Returns

Promise<number>

群聊组ID

chatGroupList

▸ chatGroupList(offset, rows, filter?): Promise<{ items: ChatGroup[] ; total: number }>

群聊组分页列表

Parameters
NameTypeDescription
offsetnumber返回记录起始偏移量
rowsnumber最大返回项目数
filter?string搜索过滤字符串(组名称或拼音首字母)
Returns

Promise<{ items: ChatGroup[] ; total: number }>

群聊组总数及分页列表

chatGroupLoadMembers

▸ chatGroupLoadMembers(id): Promise<{ id: string ; name: string }[]>

获取群聊组用户成员

Parameters
NameTypeDescription
idnumber群聊组ID
Returns

Promise<{ id: string ; name: string }[]>

群聊用户组成员ID,名称列表

chatGroupSetMembers

▸ chatGroupSetMembers(id, userIds): Promise<void>

设置群聊组用户成员

Parameters
NameTypeDescription
idnumber群聊组ID
userIdsstring[]用户ID列表
Returns

Promise<void>

chatGroupUpdate

▸ chatGroupUpdate(config): Promise<void>

更新群聊组配置

Parameters
NameTypeDescription
configChatGroup群聊组ID及配置参数 ChatGroup
Returns

Promise<void>

login

▸ login(acc, password, autoRetry): Promise<void>

登录服务器后台

Parameters
NameTypeDescription
accstring登录账号
passwordstring登录密码
autoRetryboolean会话中断,是否自动登录
Returns

Promise<void>

无

logout

▸ logout(): Promise<void>

登出系统

Returns

Promise<void>

无

storageClean

▸ storageClean(password): Promise<void>

清理存储空间

Parameters
NameTypeDescription
passwordstring登录用户密码
Returns

Promise<void>

storageClear

▸ storageClear(password): Promise<void>

初始化存储空间

Parameters
NameTypeDescription
passwordstring登录用户密码
Returns

Promise<void>

storageConfig

▸ storageConfig(password, autoClean, cleanHourPerDay?, keepDays?): Promise<void>

配置存储空间管理参数

Parameters
NameTypeDescription
passwordstring登录用户密码
autoCleanboolean后台自动清理
cleanHourPerDay?number每天清理空间时间
keepDays?number历史记录保持天数
Returns

Promise<void>

storageStateSummaryPoll

▸ storageStateSummaryPoll(): Promise<StorageStateSummary>

轮询存储状态

Returns

Promise<StorageStateSummary>

存储状态概览StorageStateSummary

systemStateSummaryPoll

▸ systemStateSummaryPoll(): Promise<SystemStateSummary>

轮询系统状态

Returns

Promise<SystemStateSummary>

系统状态概览SystemStateSummary

userAdd

▸ userAdd(config): Promise<void>

新建用户

Parameters
NameTypeDescription
configUser用户配置参数 User
Returns

Promise<void>

userDel

▸ userDel(ids): Promise<void>

批量删除用户

Parameters
NameTypeDescription
idsstring[]用户ID列表
Returns

Promise<void>

userDisable

▸ userDisable(ids): Promise<void>

禁用用户

Parameters
NameTypeDescription
idsstring[]用户ID列表
Returns

Promise<void>

userEnable

▸ userEnable(ids): Promise<void>

启用用户

Parameters
NameTypeDescription
idsstring[]用户ID列表
Returns

Promise<void>

userList

▸ userList(offset, rows, filter?): Promise<ResultOfUserList>

用户分页列表

Parameters
NameTypeDescription
offsetnumber返回记录起始偏移量
rowsnumber最大返回项目数
filter?string搜索过滤字符串(用户名称或拼音首字母)
Returns

Promise<ResultOfUserList>

用户账号总数及分页列表 ResultOfUserList[]

userReset

▸ userReset(ids): Promise<void>

重置用户密码

Parameters
NameTypeDescription
idsstring[]用户ID列表
Returns

Promise<void>

userSetPassword

▸ userSetPassword(oldPass, newPass): Promise<void>

设置当前用户登录密码

Parameters
NameTypeDescription
oldPassstring原密码
newPassstring新密码
Returns

Promise<void>

userStatePoll

▸ userStatePoll(ids): Promise<{ [userId: string]: UserState; }>

用户实时状态查询

Parameters
NameTypeDescription
idsstring[]欲查询用户ID列表
Returns

Promise<{ [userId: string]: UserState; }>

用户登录状态映射表,未登录用户不返回对应项 { userId: string: UserState }

userUpdate

▸ userUpdate(config): Promise<void>

更新用户配置

Parameters
NameTypeDescription
configUser用户ID及配置参数 User
Returns

Promise<void>

ufimsadmapi

Table of contents

Classes

Type Aliases

Type Aliases

ChatGroup

Ƭ ChatGroup: Object

群聊组配置

Type declaration

NameType
id?number
namestring

ResultOfUserList

Ƭ ResultOfUserList: Object

用户检索列表返回结果数据结构

Type declaration

NameTypeDescription
itemsUser[]用户项目列表(offset,rows范围)
totalnumber满足检索条件用户项目总数

StorageStateSummary

Ƭ StorageStateSummary: Object

数据存储状态配置

Type declaration

NameTypeDescription
recordTotalTimestring录音净时长总计
remainDurationstring剩余可存储时长
storageAutoCleanboolean硬盘是否自动清理
storageAutoCleanTimePerDaynumber硬盘自动清理时间
storageKeepDaysnumber历史存储记录保存天数
storageTotalnumber数据硬盘总容量
storageUsednumber数据硬盘占用
storedDurationstring记录已存储时长

SystemStateSummary

Ƭ SystemStateSummary: Object

系统状态概览数据结构

Type declaration

NameTypeDescription
conferenceTotalnumber占用会议室总数
partyTotalnumber会议授权总方数
partyUsednumber会议占用总方数
system{ cpuUsed: number ; memoryTotal: number ; memoryUsed: number ; storageTotal: number ; storageUsed: number }系统资源
system.cpuUsednumberCPU占用
system.memoryTotalnumber内存总数
system.memoryUsednumber内存占用
system.storageTotalnumber数据硬盘总容量
system.storageUsednumber数据硬盘占用

User

Ƭ User: Object

用户账号

Type declaration

NameTypeDescription
createTime?string | Date创建时间
enabledboolean是否启用
idstring登录ID
namestring名称

UserState

Ƭ UserState: Object

用户登录状态

Type declaration

NameTypeDescription
ipAddrstring终端IP地址
loginDurationstring登录时长
loginTimestring登录时间
@types/js-md5axiosjs-md5ufpdssessapiuuid
@everything-registry/sub-chunk-3003
1.0.2

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago