ufpdssessapi
v1.0.7
Published
unify PDS system API
Downloads
13
Readme
Enums
Enumeration: RoleRightId
用户角色权限定义
Table of contents
Enumeration Members
- CdGroups_add
- CdGroups_belongConfig
- CdGroups_del
- CdGroups_login
- CdGroups_query
- CdGroups_update
- CdtDevices_add
- CdtDevices_del
- CdtDevices_query
- CdtDevices_update
- ConferenceSystem_admin
- ConferenceSystem_log_query
- ConferenceSystem_rec_query
- ConferenceSystem_service
- GeneralQuery
- HotKeyPages_add
- HotKeyPages_del
- HotKeyPages_favorite
- HotKeyPages_query
- HotKeyPages_update
- HotKeys_add
- HotKeys_del
- HotKeys_query
- HotKeys_update
- MAP_admin
- MAP_dispatch
- Radio_admin
- Radio_dispatch
- RecordSystem_admin
- RecordSystem_recordDownload
- RecordSystem_recordPlayback
- RecordSystem_recordQuery
- Roles_admin
- Roles_query
- SMS_admin
- SMS_bcTask_add
- SMS_bcTask_del
- SMS_bcTask_query
- SysConfig_query
- SysConfig_update
- TBCSystem_admin
- TBCSystem_log_query
- TBCSystem_service
- TBCSystem_template
- Users_add
- Users_del
- Users_query
- Users_update
- VConferenceSystem_admin
- VConferenceSystem_log_query
- VConferenceSystem_rec_query
- VConferenceSystem_service
Enumeration Members
CdGroups_add
• CdGroups_add = 13
CdGroups_belongConfig
• CdGroups_belongConfig = 17
CdGroups_del
• CdGroups_del = 14
CdGroups_login
• CdGroups_login = 16
CdGroups_query
• CdGroups_query = 12
CdGroups_update
• CdGroups_update = 15
CdtDevices_add
• CdtDevices_add = 9
CdtDevices_del
• CdtDevices_del = 10
CdtDevices_query
• CdtDevices_query = 8
CdtDevices_update
• CdtDevices_update = 11
ConferenceSystem_admin
• ConferenceSystem_admin = 30
ConferenceSystem_log_query
• ConferenceSystem_log_query = 31
ConferenceSystem_rec_query
• ConferenceSystem_rec_query = 32
ConferenceSystem_service
• ConferenceSystem_service = 33
GeneralQuery
• GeneralQuery = 51
HotKeyPages_add
• HotKeyPages_add = 23
HotKeyPages_del
• HotKeyPages_del = 24
HotKeyPages_favorite
• HotKeyPages_favorite = 50
HotKeyPages_query
• HotKeyPages_query = 22
HotKeyPages_update
• HotKeyPages_update = 25
HotKeys_add
• HotKeys_add = 19
HotKeys_del
• HotKeys_del = 20
HotKeys_query
• HotKeys_query = 18
HotKeys_update
• HotKeys_update = 21
MAP_admin
• MAP_admin = 46
MAP_dispatch
• MAP_dispatch = 47
Radio_admin
• Radio_admin = 48
Radio_dispatch
• Radio_dispatch = 49
RecordSystem_admin
• RecordSystem_admin = 38
RecordSystem_recordDownload
• RecordSystem_recordDownload = 41
RecordSystem_recordPlayback
• RecordSystem_recordPlayback = 40
RecordSystem_recordQuery
• RecordSystem_recordQuery = 39
Roles_admin
• Roles_admin = 3
Roles_query
• Roles_query = 2
SMS_admin
• SMS_admin = 42
SMS_bcTask_add
• SMS_bcTask_add = 44
SMS_bcTask_del
• SMS_bcTask_del = 45
SMS_bcTask_query
• SMS_bcTask_query = 43
SysConfig_query
• SysConfig_query = 0
SysConfig_update
• SysConfig_update = 1
TBCSystem_admin
• TBCSystem_admin = 26
TBCSystem_log_query
• TBCSystem_log_query = 28
TBCSystem_service
• TBCSystem_service = 29
TBCSystem_template
• TBCSystem_template = 27
Users_add
• Users_add = 5
Users_del
• Users_del = 6
Users_query
• Users_query = 4
Users_update
• Users_update = 7
VConferenceSystem_admin
• VConferenceSystem_admin = 34
VConferenceSystem_log_query
• VConferenceSystem_log_query = 35
VConferenceSystem_rec_query
• VConferenceSystem_rec_query = 36
VConferenceSystem_service
• VConferenceSystem_service = 37
ufpdssessapi
Table of contents
Enumerations
Type Aliases
Variables
Functions
Type Aliases
SessCheckResult
Ƭ SessCheckResult: Object
会话认证结果
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| administrator | boolean | 登录用户是否管理员 |
| pwd | string | 用户登录密码 |
| rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
| userId | string | 用户状态 |
| userName | string | 用户名称 |
Session
Ƭ Session: Object
终端登录会话状态数据结构
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| administrator | boolean | 登录用户是否管理员 |
| auth_id | string | 登录认证成功后返回的会话ID |
| errMsg | string | 服务器最近返回错误信息 |
| inProgress | boolean | 是否正在登录 |
| lastRequestIndex | number | 最近发送请求序号 |
| pwd | string | 用户登录密码 |
| rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
| userId | string | 用户状态 |
| userName | string | 用户名称 |
UserCheckResult
Ƭ UserCheckResult: Object
用户认证结果
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| administrator | boolean | 登录用户是否管理员 |
| pwd | string | 用户登录密码 |
| rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
| userName | string | 用户名称 |
Variables
sess
• Const sess: Session
共享会话信息对象
Functions
saveSession
▸ saveSession(): void
保存会话信息到浏览器本地存储
Returns
void
sessionCheck
▸ sessionCheck(serverURL, auth_id, sign, requestIndex, timestamp, backServerURL?): Promise<SessCheckResult>
请求调度服务器单点会话认证
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| serverURL | string | 认证服务器URL |
| auth_id | string | 认证ID |
| sign | string | 数字签名 |
| requestIndex | number | 请求序号 |
| timestamp | number | 时间戳 |
| backServerURL? | string | 可选的备用认证服务器URL |
Returns
Promise<SessCheckResult>
会话数据SessCheckResult
userCheck
▸ userCheck(serverURL, requestIndex, timestamp, username, logincode, sign, backServerURL?): Promise<UserCheckResult>
用户账号验证
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| serverURL | string | 认证服务器URL |
| requestIndex | number | 请求序号 |
| timestamp | number | 时间戳 |
| username | string | 用户账号 |
| logincode | string | 登录加密密码 |
| sign | string | 数字签名 |
| backServerURL? | string | 可选的备用认证服务器URL |
Returns
Promise<UserCheckResult>
验证结果 UserCheckResult
Enums
Enumeration: RoleRightId
用户角色权限定义
Table of contents
Enumeration Members
- CdGroups_add
- CdGroups_belongConfig
- CdGroups_del
- CdGroups_login
- CdGroups_query
- CdGroups_update
- CdtDevices_add
- CdtDevices_del
- CdtDevices_query
- CdtDevices_update
- ConferenceSystem_admin
- ConferenceSystem_log_query
- ConferenceSystem_rec_query
- ConferenceSystem_service
- GeneralQuery
- HotKeyPages_add
- HotKeyPages_del
- HotKeyPages_favorite
- HotKeyPages_query
- HotKeyPages_update
- HotKeys_add
- HotKeys_del
- HotKeys_query
- HotKeys_update
- MAP_admin
- MAP_dispatch
- Radio_admin
- Radio_dispatch
- RecordSystem_admin
- RecordSystem_recordDownload
- RecordSystem_recordPlayback
- RecordSystem_recordQuery
- Roles_admin
- Roles_query
- SMS_admin
- SMS_bcTask_add
- SMS_bcTask_del
- SMS_bcTask_query
- SysConfig_query
- SysConfig_update
- TBCSystem_admin
- TBCSystem_log_query
- TBCSystem_reassign
- TBCSystem_service
- TBCSystem_template
- Users_add
- Users_del
- Users_query
- Users_update
- VConferenceSystem_admin
- VConferenceSystem_log_query
- VConferenceSystem_rec_query
- VConferenceSystem_service
Enumeration Members
CdGroups_add
• CdGroups_add = 13
CdGroups_belongConfig
• CdGroups_belongConfig = 17
CdGroups_del
• CdGroups_del = 14
CdGroups_login
• CdGroups_login = 16
CdGroups_query
• CdGroups_query = 12
CdGroups_update
• CdGroups_update = 15
CdtDevices_add
• CdtDevices_add = 9
CdtDevices_del
• CdtDevices_del = 10
CdtDevices_query
• CdtDevices_query = 8
CdtDevices_update
• CdtDevices_update = 11
ConferenceSystem_admin
• ConferenceSystem_admin = 30
ConferenceSystem_log_query
• ConferenceSystem_log_query = 31
ConferenceSystem_rec_query
• ConferenceSystem_rec_query = 32
ConferenceSystem_service
• ConferenceSystem_service = 33
GeneralQuery
• GeneralQuery = 51
HotKeyPages_add
• HotKeyPages_add = 23
HotKeyPages_del
• HotKeyPages_del = 24
HotKeyPages_favorite
• HotKeyPages_favorite = 50
HotKeyPages_query
• HotKeyPages_query = 22
HotKeyPages_update
• HotKeyPages_update = 25
HotKeys_add
• HotKeys_add = 19
HotKeys_del
• HotKeys_del = 20
HotKeys_query
• HotKeys_query = 18
HotKeys_update
• HotKeys_update = 21
MAP_admin
• MAP_admin = 46
MAP_dispatch
• MAP_dispatch = 47
Radio_admin
• Radio_admin = 48
Radio_dispatch
• Radio_dispatch = 49
RecordSystem_admin
• RecordSystem_admin = 38
RecordSystem_recordDownload
• RecordSystem_recordDownload = 41
RecordSystem_recordPlayback
• RecordSystem_recordPlayback = 40
RecordSystem_recordQuery
• RecordSystem_recordQuery = 39
Roles_admin
• Roles_admin = 3
Roles_query
• Roles_query = 2
SMS_admin
• SMS_admin = 42
SMS_bcTask_add
• SMS_bcTask_add = 44
SMS_bcTask_del
• SMS_bcTask_del = 45
SMS_bcTask_query
• SMS_bcTask_query = 43
SysConfig_query
• SysConfig_query = 0
SysConfig_update
• SysConfig_update = 1
TBCSystem_admin
• TBCSystem_admin = 26
TBCSystem_log_query
• TBCSystem_log_query = 28
TBCSystem_reassign
• TBCSystem_reassign = 52
TBCSystem_service
• TBCSystem_service = 29
TBCSystem_template
• TBCSystem_template = 27
Users_add
• Users_add = 5
Users_del
• Users_del = 6
Users_query
• Users_query = 4
Users_update
• Users_update = 7
VConferenceSystem_admin
• VConferenceSystem_admin = 34
VConferenceSystem_log_query
• VConferenceSystem_log_query = 35
VConferenceSystem_rec_query
• VConferenceSystem_rec_query = 36
VConferenceSystem_service
• VConferenceSystem_service = 37
ufpdssessapi
Table of contents
Enumerations
Type Aliases
Variables
Functions
Type Aliases
SessCheckResult
Ƭ SessCheckResult: Object
会话认证结果
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| administrator | boolean | 登录用户是否管理员 |
| pwd | string | 用户登录密码 |
| rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
| userId | string | 用户状态 |
| userName | string | 用户名称 |
Session
Ƭ Session: Object
终端登录会话状态数据结构
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| administrator | boolean | 登录用户是否管理员 |
| auth_id | string | 登录认证成功后返回的会话ID |
| errMsg | string | 服务器最近返回错误信息 |
| inProgress | boolean | 是否正在登录 |
| lastRequestIndex | number | 最近发送请求序号 |
| pwd | string | 用户登录密码 |
| rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
| userId | string | 用户状态 |
| userName | string | 用户名称 |
UserCheckResult
Ƭ UserCheckResult: Object
用户认证结果
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| administrator | boolean | 登录用户是否管理员 |
| pwd | string | 用户登录密码 |
| rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
| userName | string | 用户名称 |
Variables
sess
• Const sess: Session
共享会话信息对象
Functions
saveSession
▸ saveSession(): void
保存会话信息到浏览器本地存储
Returns
void
sessionCheck
▸ sessionCheck(serverURL, auth_id, sign, requestIndex, timestamp, backServerURL?): Promise<SessCheckResult>
请求调度服务器单点会话认证
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| serverURL | string | 认证服务器URL |
| auth_id | string | 认证ID |
| sign | string | 数字签名 |
| requestIndex | number | 请求序号 |
| timestamp | number | 时间戳 |
| backServerURL? | string | 可选的备用认证服务器URL |
Returns
Promise<SessCheckResult>
会话数据SessCheckResult
userCheck
▸ userCheck(serverURL, requestIndex, timestamp, username, logincode, sign, backServerURL?): Promise<UserCheckResult>
用户账号验证
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| serverURL | string | 认证服务器URL |
| requestIndex | number | 请求序号 |
| timestamp | number | 时间戳 |
| username | string | 用户账号 |
| logincode | string | 登录加密密码 |
| sign | string | 数字签名 |
| backServerURL? | string | 可选的备用认证服务器URL |
Returns
Promise<UserCheckResult>
验证结果 UserCheckResult