com.seeyon.apps.uc.api

接口 UcApi

所有超级接口:

com.seeyon.ctp.common.fontimage.GroupManager

所有已知实现类:

AbstractUcApi

public interface UcApi
extends com.seeyon.ctp.common.fontimage.GroupManager

UC接口

方法概要

限定符和类型	方法和说明
java.util.Map<java.lang.String,java.lang.String>	getLoginC2sUC(java.lang.String memberId) 获取致信中人员登陆信息(客户端连接) 正常: 1、传入人员ID获取用户上线信息包括jid、token、port、extranetIp、 intranetIp、 异常: 2、不能取到jid、token、port、extranetIp、 intranetIp
java.util.Map<java.lang.String,java.lang.String>	getLoginUC(java.lang.String memberId) 获取致信中人员登陆信息 正常: 1、传入人员ID获取用户上线信息包括jid、token、port、extranetIp、 intranetIp、 异常: 2、不能取到jid、token、port、extranetIp、 intranetIp
int	getRongState(java.lang.String memberId) 返回融云用户状态
java.lang.String	getUcC2sPort() 获取客户端访问端口 正常: 1、调用此接口（已配置致信客户端访问端口），返回致信客户端访问端口 2、调用此接口（未配置致信客户端访问端口），返回空
java.util.Map	getUcMessageByMemberId(java.lang.String memberId) 通过用户编号获取人员最近的消息列表，只能获取一次 正常 1、传入人员编号获取最近消息列表Map * 异常: 2、没有返回为空
java.lang.String	getUcRongCacheValue(java.lang.String key) 获取初始化融云数据中存储的值
java.lang.String	getUcServerInip() 获取UC服务器内网地址 正常: 1、调用此接口（已配置致信内网地址），返回致信服务器内网地址 2、调用此接口（未配置致信内网地址），返回空
java.lang.String	getUcServerOutip() 获取UC服务器外网地址 正常: 1、调用此接口（已配置致信外网地址），返回致信服务器外网地址 2、调用此接口（未配置致信外网地址），返回空
java.lang.Integer	publishMobilePrivateDonotPush(java.lang.String sendId, java.lang.String[] toIds, java.lang.String content, java.lang.String extra, java.lang.String pushContent, java.lang.String pushData, java.lang.String count, java.lang.Integer verifyBlacklist, java.lang.Integer isPersisted, java.lang.Integer isCounted, java.lang.Integer isIncludeSender) 发送移动消息消息
void	syncAddressBookSet(java.lang.Long accountId) 同步通讯录设置 正常: 1、传入正确的单位id，成功同步这个单位的通讯录设置
void	syncUpdateMessageState(java.lang.Long memberId) 同步更新消息已读状态 正常: 1、传入正确的人员id，成功同步消息状态 异常: 2、传入错误的人员id，同步失败，抛异常
void	syncUpdateMessageState(java.lang.Long memberId, int messageCategory) 同步更新消息已读状态 正常: 1、传入正确的人员id和消息分类id（如协同），成功同步消息状态 异常: 2、所有参数传入null，抛异常
void	syncUpdateMessageState(java.lang.Long memberId, java.lang.Long messageId) 同步更新消息已读状态 正常: 1、传入正确的人员id和消息id，成功同步消息状态 异常: 2、所有参数传入null，抛异常

从接口继承的方法 com.seeyon.ctp.common.fontimage.GroupManager

getGroupMemberIdArray

方法详细资料

syncAddressBookSet

void syncAddressBookSet(java.lang.Long accountId)
                 throws com.seeyon.ctp.common.exceptions.BusinessException

同步通讯录设置 正常:
1、传入正确的单位id，成功同步这个单位的通讯录设置

参数:

accountId - 单位id

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

syncUpdateMessageState

void syncUpdateMessageState(java.lang.Long memberId)
                     throws com.seeyon.ctp.common.exceptions.BusinessException

同步更新消息已读状态 正常:
1、传入正确的人员id，成功同步消息状态
异常:
2、传入错误的人员id，同步失败，抛异常

参数:

memberId - 人员id

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

syncUpdateMessageState

void syncUpdateMessageState(java.lang.Long memberId,
                            int messageCategory)
                     throws com.seeyon.ctp.common.exceptions.BusinessException

同步更新消息已读状态 正常:
1、传入正确的人员id和消息分类id（如协同），成功同步消息状态
异常:
2、所有参数传入null，抛异常

参数:

memberId - 人员id

messageCategory - 消息分类（如：协同）

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

syncUpdateMessageState

void syncUpdateMessageState(java.lang.Long memberId,
                            java.lang.Long messageId)
                     throws com.seeyon.ctp.common.exceptions.BusinessException

同步更新消息已读状态 正常:
1、传入正确的人员id和消息id，成功同步消息状态
异常:
2、所有参数传入null，抛异常

参数:

memberId - 人员id

messageId - 消息id

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

getUcServerInip

java.lang.String getUcServerInip()
                          throws com.seeyon.ctp.common.exceptions.BusinessException

获取UC服务器内网地址
正常:
1、调用此接口（已配置致信内网地址），返回致信服务器内网地址
2、调用此接口（未配置致信内网地址），返回空

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

getUcServerOutip

java.lang.String getUcServerOutip()
                           throws com.seeyon.ctp.common.exceptions.BusinessException

获取UC服务器外网地址
正常:
1、调用此接口（已配置致信外网地址），返回致信服务器外网地址
2、调用此接口（未配置致信外网地址），返回空

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

getUcC2sPort

java.lang.String getUcC2sPort()
                       throws com.seeyon.ctp.common.exceptions.BusinessException

获取客户端访问端口 正常:
1、调用此接口（已配置致信客户端访问端口），返回致信客户端访问端口
2、调用此接口（未配置致信客户端访问端口），返回空

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

getLoginUC

java.util.Map<java.lang.String,java.lang.String> getLoginUC(java.lang.String memberId)
                                                     throws java.lang.Exception

获取致信中人员登陆信息 正常:
1、传入人员ID获取用户上线信息包括jid、token、port、extranetIp、 intranetIp、 异常:
2、不能取到jid、token、port、extranetIp、 intranetIp

参数:

memberId -

返回:

抛出:

java.lang.Exception

getLoginC2sUC

java.util.Map<java.lang.String,java.lang.String> getLoginC2sUC(java.lang.String memberId)
                                                        throws java.lang.Exception

获取致信中人员登陆信息(客户端连接) 正常:
1、传入人员ID获取用户上线信息包括jid、token、port、extranetIp、 intranetIp、 异常:
2、不能取到jid、token、port、extranetIp、 intranetIp

参数:

memberId -

返回:

抛出:

java.lang.Exception

getUcMessageByMemberId

java.util.Map getUcMessageByMemberId(java.lang.String memberId)

通过用户编号获取人员最近的消息列表，只能获取一次 正常
1、传入人员编号获取最近消息列表Map * 异常:
2、没有返回为空

参数:

memberId -

返回:

publishMobilePrivateDonotPush

java.lang.Integer publishMobilePrivateDonotPush(java.lang.String sendId,
                                                java.lang.String[] toIds,
                                                java.lang.String content,
                                                java.lang.String extra,
                                                java.lang.String pushContent,
                                                java.lang.String pushData,
                                                java.lang.String count,
                                                java.lang.Integer verifyBlacklist,
                                                java.lang.Integer isPersisted,
                                                java.lang.Integer isCounted,
                                                java.lang.Integer isIncludeSender)

发送移动消息消息

参数:

fromUserId:发送人用户 - Id。（必传）

toUserId:接收用户 - Id，可以实现向多人发送消息，每次上限为 1000 人。（必传）

content: - mobileOAMessage内的消息内容

extra: - mobileOAMessage内的扩展内容

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息。如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）

count:针对 - iOS 平台，Push 时用来控制未读消息显示数，只有在 toUserId 为一个用户 Id 的时候有效。（可选）

verifyBlacklist:是否过滤发送人黑名单列表，0 - 表示为不过滤、 1 表示为过滤，默认为 0 不过滤。（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）

isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 - 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）

isIncludeSender:发送用户自已是否接收消息，0 - 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）

返回:

CodeSuccessResult

getUcRongCacheValue

java.lang.String getUcRongCacheValue(java.lang.String key)

获取初始化融云数据中存储的值

参数:

key - "uc_Channel"：通道,"uc_deployment":部署方式，公有云/私有云.... 具体参考UcConstants类中以UC_为前缀的常量

返回:

getRongState

int getRongState(java.lang.String memberId)

返回融云用户状态

参数:

memberId - 人员id Long

返回:

0：正常；1：未授权；2：已过期 Int