public interface PortalAPI
限定符和类型 | 方法和说明 |
---|---|
java.lang.String |
changePasswd(UserContext userContext,
java.lang.String oldPwd,
java.lang.String newPwd)
修改个人账户登录口令
|
void |
changeUserLanguages(java.lang.String sid,
java.lang.String lang)
改变用户界面语言
|
boolean |
checkSession(java.lang.String sid)
检查session有效性,如果有效则刷新一次session,延长session生命周期
|
boolean |
closeSession(java.lang.String sid)
注销一个会话
|
java.lang.String |
createClientSession(java.lang.String uid,
java.lang.String pwd)
创建一个客户端用户会话
|
java.lang.String |
createClientSession(java.lang.String uid,
java.lang.String pwd,
java.lang.String timeZone)
创建一个客户端用户会话
|
java.lang.String |
createClientSessionByDevice(java.lang.String uid,
java.lang.String pwd,
java.lang.String lang,
java.lang.String userIp,
java.lang.String deviceType)
创建一个客户端用户会话
|
java.lang.String |
createClientSessionByDevice(java.lang.String uid,
java.lang.String pwd,
java.lang.String lang,
java.lang.String userIp,
java.lang.String deviceType,
java.lang.String timeZone)
创建一个客户端用户会话
|
java.lang.String |
createClientSessionByPC(java.lang.String uid,
java.lang.String pwd,
java.lang.String lang,
java.lang.String userIp)
创建一个客户端用户会话
|
java.lang.String |
createClientSessionByPC(java.lang.String uid,
java.lang.String pwd,
java.lang.String lang,
java.lang.String userIp,
java.lang.String timeZone)
创建一个客户端用户会话
|
java.lang.String |
getMessagePage(java.lang.String title,
java.lang.String desc,
java.lang.String messageType)
获取指定类型的信息反馈页面
|
java.lang.String |
getMessagePageOfAuthority(java.lang.String title,
java.lang.String desc)
获取权限、身份、安全类警告反馈页面
|
java.lang.String |
getMessagePageOfError(java.lang.String title,
java.lang.String desc)
获取出错反馈页面
|
java.lang.String |
getMessagePageOfInfo(java.lang.String title,
java.lang.String desc)
获取提示反馈页面
|
java.lang.String |
getMessagePageOfNoContent(java.lang.String title,
java.lang.String desc)
获取无数据、空记录场景反馈页面
|
java.lang.String |
getMessagePageOfNoData(java.lang.String title,
java.lang.String desc)
获取建模类的无数据、空记录场景反馈页面
|
java.lang.String |
getMessagePageOfNoSearch(java.lang.String title,
java.lang.String desc)
获取搜索结果无数据场景反馈页面
|
java.lang.String |
getMessagePageOfOk(java.lang.String title,
java.lang.String desc)
获取成功反馈页面
|
java.lang.String |
getMessagePageOfWait(java.lang.String title,
java.lang.String desc)
获取正在处理类操作的重试类反馈页面
|
java.lang.String |
getMessagePageOfWarning(java.lang.String title,
java.lang.String desc)
获取警告反馈页面
|
net.sf.json.JSONArray |
getNavList(UserContext userContext,
java.lang.String parentId)
已过时。
|
net.sf.json.JSONArray |
getNavListBySysId(UserContext userContext,
java.lang.String navSysId)
已过时。
|
net.sf.json.JSONArray |
getNavTree(UserContext userContext)
已过时。
|
java.lang.String |
getOnlineIcon(java.lang.String uid)
返回指定用户的在线图标URL
|
int |
getOnlineUserCount()
返回当前有效的在线用户数量
|
java.util.List<OnlineUserModel> |
getOnlineUserList()
返回当前系统有效的在线用户列表
|
java.lang.String |
getPortalUrl()
当前AWS平台Portal URL根地址
|
net.sf.json.JSONArray |
getPublicPortlet(UserContext userContext)
已过时。
已经作废,将会返回一个空的数组
|
java.lang.String |
getRequiredUserInfo(UserContext userContext)
个人配置信息必填项,部分门户可以支持弹出对话框强行提示完善(如Metro门户)。
|
java.lang.String |
getTaskInstTokenUrl(java.lang.String taskInstId)
获取任务的token url,不需要用户sid即可以访问某任务页面。
|
java.lang.String |
getUserInfo(UserContext userContext,
java.lang.String uid)
获得指定用户的基本信息资料
|
net.sf.json.JSONArray |
getUserLoginLog(UserContext userContext,
int top)
已过时。
使用
#queryUserLoginLog(userContext,top) 方法替代 |
java.lang.String |
getUserPhoto(UserContext userContext,
java.lang.String uid)
获得指定账户头像URL资源,如果该用户未设置,给出一个默认头像
|
java.lang.String |
getUserProfileItem(java.lang.String appId,
java.lang.String userId,
java.lang.String profileKey,
java.lang.String itemName)
获得用户自定义的参数项
|
net.sf.json.JSONObject |
getUserProfileSchema(java.lang.String appId,
java.lang.String uid,
java.lang.String profileKey)
已过时。
使用
#queryUserProfileSchema(appId,uid,profileKey) 方法替代 |
boolean |
isChangePasswd(UserContext userContext)
根据AWS平台配置策略,是否允许个人修改口令
|
boolean |
isChangePasswdCycle(UserContext userContext)
根据AWS平台三员安全的配置策略,当前是否到了要修改口令的时间。
|
boolean |
isOnline(java.lang.String uid)
判断指定账户是否在线
|
java.util.Map<java.lang.String,java.lang.Boolean> |
isOnline(java.lang.String[] uids)
判断指定账户是否在线。
|
JSONArray |
queryNavList(UserContext userContext,
java.lang.String parentId)
获得指定用户可访问的下一级功能菜单定义
|
JSONArray |
queryNavListBySysId(UserContext userContext,
java.lang.String navSysId)
获取子系统导航下的所有功能菜单定义
|
JSONArray |
queryNavTree(UserContext userContext)
获得指定用户可访问的导航树全部功能菜单定义
|
JSONArray |
queryUserLoginLog(UserContext userContext,
int top)
获得当前用户前n条的登录日志
|
JSONObject |
queryUserProfileSchema(java.lang.String appId,
java.lang.String uid,
java.lang.String profileKey)
获得用户自定义的参数结构
|
boolean |
refreshSession(java.lang.String sid)
刷新一次session,延长session生命周期
|
java.lang.String |
saveUserInfo(UserContext userContext,
JSONObject data)
保存个人基本信息,该API只允许更新个人资料
|
java.lang.String |
setUserInfo(UserContext userContext,
net.sf.json.JSONObject data)
已过时。
|
boolean |
setUserProfileItem(java.lang.String appId,
java.lang.String uid,
java.lang.String profileKey,
java.lang.String itemName,
java.lang.String itemValue)
设置用户自定义的参数项
|
boolean |
setUserProfileSchema(java.lang.String appId,
java.lang.String uid,
java.lang.String profileKey,
JSONObject json)
设置用户自定义的参数结构
|
boolean |
setUserProfileSchema(java.lang.String appId,
java.lang.String uid,
java.lang.String profileKey,
net.sf.json.JSONObject json)
已过时。
已经作废
|
@Deprecated net.sf.json.JSONArray getNavTree(UserContext userContext)
queryNavTree(UserContext)
方法替代userContext
- 用户上下文对象JSONArray queryNavTree(UserContext userContext)
userContext
- 用户上下文对象@Deprecated net.sf.json.JSONArray getNavList(UserContext userContext, java.lang.String parentId)
queryNavList(UserContext, String)
方法替代userContext
- 用户上下文对象parentId
- 父节点ID,父节点ID可以是子系统、目录,如果给定null或空,显示子系统JSONArray queryNavList(UserContext userContext, java.lang.String parentId)
userContext
- 用户上下文对象parentId
- 父节点ID,父节点ID可以是子系统、目录,如果给定null或空,显示子系统@Deprecated net.sf.json.JSONArray getNavListBySysId(UserContext userContext, java.lang.String navSysId)
queryNavListBySysId(UserContext, String)
方法替代userContext
- 用户上下文对象navSysId
- 导航子系统IDJSONArray queryNavListBySysId(UserContext userContext, java.lang.String navSysId)
userContext
- 用户上下文对象navSysId
- 导航子系统ID@Deprecated net.sf.json.JSONArray getPublicPortlet(UserContext userContext)
userContext
- 用户上下文对象boolean isChangePasswd(UserContext userContext)
userContext
- 用户上下文boolean isChangePasswdCycle(UserContext userContext)
userContext
- 用户上下文java.lang.String changePasswd(UserContext userContext, java.lang.String oldPwd, java.lang.String newPwd)
userContext
- 用户上下文oldPwd
- 旧口令newPwd
- 新口令java.lang.String getRequiredUserInfo(UserContext userContext)
userContext
- 用户上下文java.lang.String getUserPhoto(UserContext userContext, java.lang.String uid)
userContext
- 用户上下文对象uid
- 一个合法的AWS账户名java.lang.String getUserInfo(UserContext userContext, java.lang.String uid)
userContext
- 用户上下文对象uid
- 一个合法的AWS账户名@Deprecated java.lang.String setUserInfo(UserContext userContext, net.sf.json.JSONObject data)
userContext
- 用户上下文对象data
- 更新的数据项[userName(姓名),mobile(手机号码),smId(短信手机号码),email(外网邮件 ),officeTel(办公电话),officeFax(办公传真),sessionTime(会话时长)]java.lang.String saveUserInfo(UserContext userContext, JSONObject data)
userContext
- 用户上下文对象data
- 更新的数据项[userName(姓名),mobile(手机号码),smId(短信手机号码),email(外网邮件 ),officeTel(办公电话),officeFax(办公传真),sessionTime(会话时长)]java.lang.String createClientSession(java.lang.String uid, java.lang.String pwd)
uid
- 一个合法的AWS账户名pwd
- 口令AWSAPIException
java.lang.String createClientSession(java.lang.String uid, java.lang.String pwd, java.lang.String timeZone)
uid
- 一个合法的AWS账户名pwd
- 口令timeZone
- 传递UTC偏移量,用以下形式表示:±[hh]:[mm],如“+01:00”。如果为空,使用JVM指定的时区或者JVM所在操作系统的时区AWSAPIException
java.lang.String createClientSessionByPC(java.lang.String uid, java.lang.String pwd, java.lang.String lang, java.lang.String userIp)
uid
- 一个合法的AWS账户名pwd
- 口令lang
- 界面语言,常用语言:cn/en/big5userIp
- 客户端IP地址AWSAPIException
PlatformAPI.getlanguages()
java.lang.String createClientSessionByPC(java.lang.String uid, java.lang.String pwd, java.lang.String lang, java.lang.String userIp, java.lang.String timeZone)
uid
- 一个合法的AWS账户名pwd
- 口令lang
- 界面语言,常用语言:cn/en/big5userIp
- 客户端IP地址timeZone
- 传递UTC偏移量,用以下形式表示:±[hh]:[mm],如“+01:00”。如果为空,使用JVM指定的时区或者JVM所在操作系统的时区AWSAPIException
PlatformAPI.getlanguages()
java.lang.String createClientSessionByDevice(java.lang.String uid, java.lang.String pwd, java.lang.String lang, java.lang.String userIp, java.lang.String deviceType)
uid
- 一个合法的AWS账户名pwd
- 口令lang
- 界面语言,常用语言:cn/en/big5userIp
- 客户端IP地址deviceType
- 终端登录设备类型,支持pc/mobile/tablet,见LoginConst常量AWSAPIException
PlatformAPI.getlanguages()
java.lang.String createClientSessionByDevice(java.lang.String uid, java.lang.String pwd, java.lang.String lang, java.lang.String userIp, java.lang.String deviceType, java.lang.String timeZone)
uid
- 一个合法的AWS账户名pwd
- 口令lang
- 界面语言,常用语言:cn/en/big5userIp
- 客户端IP地址deviceType
- 终端登录设备类型,支持pc/mobile/tablet,见LoginConst常量timeZone
- 传递UTC偏移量,用以下形式表示:±[hh]:[mm],如“+01:00”。如果为空,使用JVM指定的时区或者JVM所在操作系统的时区AWSAPIException
PlatformAPI.getlanguages()
boolean checkSession(java.lang.String sid)
sid
- session串boolean closeSession(java.lang.String sid)
sid
- session串boolean refreshSession(java.lang.String sid)
sid
- 会话IDJSONArray queryUserLoginLog(UserContext userContext, int top)
userContext
- 用户上下文top
- 最近前n条,最大不允许超过100@Deprecated net.sf.json.JSONArray getUserLoginLog(UserContext userContext, int top)
#queryUserLoginLog(userContext,top)
方法替代userContext
- 用户上下文top
- 最近前n条,最大不允许超过100JSONObject queryUserProfileSchema(java.lang.String appId, java.lang.String uid, java.lang.String profileKey)
appId
- 应用Iduid
- 一个合法的AWS账户名profileKey
- 配置项@Deprecated net.sf.json.JSONObject getUserProfileSchema(java.lang.String appId, java.lang.String uid, java.lang.String profileKey)
#queryUserProfileSchema(appId,uid,profileKey)
方法替代appId
- 应用Iduid
- 一个合法的AWS账户名profileKey
- 配置项java.lang.String getUserProfileItem(java.lang.String appId, java.lang.String userId, java.lang.String profileKey, java.lang.String itemName)
appId
- 应用IduserId
- 一个合法的AWS账户名profileKey
- 配置项itemName
- 细项Key@Deprecated boolean setUserProfileSchema(java.lang.String appId, java.lang.String uid, java.lang.String profileKey, net.sf.json.JSONObject json)
appId
- 应用Iduid
- 一个合法的AWS账户名profileKey
- 配置项json
- 一个Json对象,最大长度不允许超过2000个字符boolean setUserProfileSchema(java.lang.String appId, java.lang.String uid, java.lang.String profileKey, JSONObject json)
appId
- 应用Iduid
- 一个合法的AWS账户名profileKey
- 配置项json
- 一个Json对象,最大长度不允许超过2000个字符boolean setUserProfileItem(java.lang.String appId, java.lang.String uid, java.lang.String profileKey, java.lang.String itemName, java.lang.String itemValue)
appId
- 应用Iduid
- 一个合法的AWS账户名profileKey
- 配置项itemName
- 细项KeyitemValue
- 细项值java.lang.String getMessagePageOfOk(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfError(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfWarning(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfInfo(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfAuthority(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfWait(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfNoContent(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfNoData(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePageOfNoSearch(java.lang.String title, java.lang.String desc)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getMessagePage(java.lang.String title, java.lang.String desc, java.lang.String messageType)
title
- 标题信息 (允许空)desc
- 描述信息(允许空)messageType
- 图标类型,见https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage。如果messageType包含“/”,则使用指定的图片文件https://docs.awspaas.com/help/commons/awsui/#feedback/messagePage
java.lang.String getOnlineIcon(java.lang.String uid)
uid
- 一个合法的AWS账户名ORGAPI
int getOnlineUserCount()
ORGAPI
java.util.List<OnlineUserModel> getOnlineUserList()
OnlineUserModel
,
ORGAPI
boolean isOnline(java.lang.String uid)
uid
- 一个合法的AWS账户名ORGAPI
java.util.Map<java.lang.String,java.lang.Boolean> isOnline(java.lang.String[] uids)
uids
- 合法的AWS账户名ORGAPI
java.lang.String getTaskInstTokenUrl(java.lang.String taskInstId)
taskInstId
- 任务实例Idvoid changeUserLanguages(java.lang.String sid, java.lang.String lang)
sid
- session串lang
- 语言,常用:cn/en/big5PlatformAPI.getlanguages()
java.lang.String getPortalUrl()
PlatformAPI.getPortalUrl()
Copyright © Actionsoft Co., Ltd. All Rights Reserved.