序列化表格 (RainbowChatServer_pro v11.0 通用常量等API文档)

程序包 com.eva.framework.dto
- 类com.eva.framework.dto.DataFromClient扩展java.lang.Object实现可序列化
  
  serialVersionUID:
  
  336408924788567851L
  - 序列化字段
    - doInput
```
boolean doInput
```
      客户端是否需要读取服务端返回的数据（对服务端而言就是是否需要写返回写据给客户端，服务端将据此决定是否要写回数据），本字段对应于 HttpURLConnection.setDoInput(boolean) 并与之保持一致。注：本字段仅用于底层数据通信，请勿作其它用途！
    - processorId
```
int processorId
```
      业务处理器id
      
      另请参阅:
      
      HttpController
    - jobDispatchId
```
int jobDispatchId
```
      作业调度器id
      
      另请参阅:
      
      HttpController
    - actionId
```
int actionId
```
      动作id
      
      另请参阅:
      
      HttpController
    - newData
```
java.lang.Object newData
```
      具体业务中：客端发送过来的本次修改新数据(可能为空，理论上与oldData不会同时空）
    - oldData
```
java.lang.Object oldData
```
      具体业务中：客端发送过来的本次修改前的老数据(可能为空，理论上与newData不会同时空）
    - token
```
java.lang.String token
```
      可用于REST请求时客户端携带到服务端作为身份验证之用。
      本字段可由框架使用者按需使用，非EVA框架必须的。
      
      从以下版本开始:
      
      20170223
    - device
```
int device
```
      发起HTTP请求的设备类型（默认值为-1，表示未定义）. 此字段为保留字段，具体意义由开发者可自行决定。
      当前默认的约定是：0 android平台、1 ios平台、2 web平台。
- 类com.eva.framework.dto.DataFromClient4Web扩展DataFromClient实现可序列化
  
  serialVersionUID:
  
  1L
  - 序列化字段
    - format
```
java.lang.String format
```
      数据返回格式
    - jsoncallback
```
java.lang.String jsoncallback
```
      本参数只在retFormat= DataFromClient4Web.RET_FORMAT_JSONP 时有意义，表示jsonp对应的客户端JS回调函数. 补充：为了兼容jQuery的跨域回调，参数名就定为jsoncallback了
- 类com.eva.framework.dto.DataFromServer扩展java.lang.Object实现可序列化
  
  serialVersionUID:
  
  -2054860604702171939L
  - 序列化字段
    - success
```
boolean success
```
      处理成功与否的状态标识：true表示处理成功，反之表示失败
    - returnValue
```
java.lang.Object returnValue
```
      处理完成后的返回值（视具体业务而定，一般来讲，服务器端处理请求时如遇失败，则本对象默认是一个Exception对象）
    - code
```
int code
```
      返回码，-1时表未设定（无意义）
- 类com.eva.framework.dto.LoginInfo2扩展java.lang.Object实现可序列化
  - 序列化字段
    - appKey
```
java.lang.String appKey
```
      当客户端的APPKey与服务端允许的APPKey一致时，才允许许登录。
      
      从以下版本开始:
      
      10.0
    - loginName
```
java.lang.String loginName
```
      用户登陆名
    - clientVersion
```
java.lang.String clientVersion
```
      客户端的版本号
    - loginPsw
```
java.lang.String loginPsw
```
      该密码可能是加密后的字串
    - deviceInfo
```
java.lang.String deviceInfo
```
      用于记录用户的登陆设备信息，比如手机登陆时的手机型号等（本字段主要用于信息记录和传递，非核心字段，可为null）
    - osType
```
java.lang.String osType
```
      设备系统类型.
      当前约定：0-Android客户端，1-iOS客户端，2-Web客户端 .
      注意：请尽量确保本字段的含义与 LogoutInfo中的osType字段相同。
    - deviceID
```
java.lang.String deviceID
```
      设备标识码：用于唯一标识此设备的id.
      当 LoginInfo2.osType=1时，本字段存放的是ios设备的device token，可用于服务端实现向此ios设备的离线消息推送（通过苹果的APNs服务实现）。
程序包 com.x52im.rainbowchat.http.logic.dto
- 类com.x52im.rainbowchat.http.logic.dto.CosplayRes扩展java.lang.Object实现可序列化
  - 序列化字段
    - res_id
```
java.lang.String res_id
```
    - res_name
```
java.lang.String res_name
```
    - res_human_size
```
java.lang.String res_human_size
```
    - res_size
```
java.lang.String res_size
```
    - flag_type
```
java.lang.String flag_type
```
    - download_count
```
java.lang.String download_count
```
    - create_time
```
java.lang.String create_time
```
    - cover_pic_path
```
java.lang.String cover_pic_path
```
    - res_path
```
java.lang.String res_path
```
    - res_status
```
java.lang.String res_status
```
    - res_bz
```
java.lang.String res_bz
```
- 类com.x52im.rainbowchat.http.logic.dto.GiftProcessResult扩展java.lang.Object实现可序列化
  
  serialVersionUID:
  
  1L
  - 序列化字段
    - resultCode
```
int resultCode
```
      礼品赠数据处理结果返回码
    - resultValue
```
java.lang.String resultValue
```
      礼品赠数据处理结果返回值：目前任何情况下此值都是该用户的当前总积分数（便于客户端及时刷新用户的最新总积分，而不用单独再开启一次Http查询）
- 类com.x52im.rainbowchat.http.logic.dto.GroupEntity扩展java.lang.Object实现可序列化
  - 序列化字段
    - g_id
```
java.lang.String g_id
```
      群id
    - g_status
```
java.lang.String g_status
```
      群状态
    - g_name
```
java.lang.String g_name
```
      群名字
    - g_owner_user_uid
```
java.lang.String g_owner_user_uid
```
      群主uid
    - g_notice
```
java.lang.String g_notice
```
      群公告
    - max_member_count
```
java.lang.String max_member_count
```
      最大群员数
    - g_member_count
```
java.lang.String g_member_count
```
      当前群员数
    - create_user_name
```
java.lang.String create_user_name
```
      群创建者昵称 @since 4.5
    - create_time
```
java.lang.String create_time
```
      群创建时间
    - g_owner_name
```
java.lang.String g_owner_name
```
      群主昵称
    - nickname_ingroup
```
java.lang.String nickname_ingroup
```
      "我"在本群中的昵称（本字段只在针对”我“的群组信息查询时才有意义）
    - imIsInGroup
```
java.lang.String imIsInGroup
```
      ”我“是否在此群里（存在则返回1，不存在则返回0，返回-1表示不需要查询此值）
    - g_notice_updatetime
```
java.lang.String g_notice_updatetime
```
      群公告更新时间
    - g_notice_updateuid
```
java.lang.String g_notice_updateuid
```
      群公告更新者
    - g_notice_updatenick
```
java.lang.String g_notice_updatenick
```
      群公告更新者昵称
- 类com.x52im.rainbowchat.http.logic.dto.RosterElementEntity扩展java.lang.Object实现可序列化
  - 序列化字段
    - ex1
```
java.lang.String ex1
```
      本字段当前仅用作服务端转发加好友请求（给B）时存放“验证说明文本”使用（包括离线时的好友请求）.
      
      从以下版本开始:
      
      2.2
    - ex10
```
java.lang.String ex10
```
      本字段当前仅用作服务端转发加好友请求（给B）时存放“加好友请求发起时间戳”使用（包括离线时的好友请求）.
      
      从以下版本开始:
      
      4.2
    - ex11
```
java.lang.String ex11
```
      保留字段11：留作协议升级时备用，生产环境下备用字段将能在协议升级时起到兼容旧版本的作用。
    - ex12
```
java.lang.String ex12
```
      保留字段12：留作协议升级时备用，生产环境下备用字段将能在协议升级时起到兼容旧版本的作用。
    - ex13
```
java.lang.String ex13
```
      保留字段13：留作协议升级时备用，生产环境下备用字段将能在协议升级时起到兼容旧版本的作用。
    - ex14
```
java.lang.String ex14
```
      保留字段14：留作协议升级时备用，生产环境下备用字段将能在协议升级时起到兼容旧版本的作用。
    - ex15
```
java.lang.String ex15
```
      保留字段15：留作协议升级时备用，生产环境下备用字段将能在协议升级时起到兼容旧版本的作用。
    - mustVersion4A
```
java.lang.String mustVersion4A
```
      本字段用于控制Android客户端的版本。作用是当出现某致命bug或重要功能时，可以强制要求用户更新，否则将无法登陆进APP。
      用法是：
      * 当本字段为空时，表示不开启强制更新，否由开启强制更新；
      * 当客户端版本小于本次强制版本号时，客户端将会被强制要求更新，更新说明即是 RosterElementEntity.ex14所指明的内容。
      补充说明：
      本字段值为null或整数字符串，版本号对应于Android端的AndroidManifest.xml文件中定义的versionCode。
    - mustVersionDesc4A
```
java.lang.String mustVersionDesc4A
```
      本字段配合 RosterElementEntity.mustVersion4A 完成强制Android端版本更新的控制。
      当开启强制客户端更新时，客户端会将此字段内容显示在UI上，提升用户体验。
    - userAvatarFileName
```
java.lang.String userAvatarFileName
```
      存放于文件服务器的用户头像文件名。
      用户客户端缓存时使用，因为用户头像读取的HTTP服务URL并不是静态地址，而是复杂的动态查询URL，在缓存文件时就无法通过URL通取到文件名称，所以本参数的作用就是缓存时用于文件名称哦）。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
    - whatsUp
```
java.lang.String whatsUp
```
      存放用户心情（60个字符哦）。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
    - maxFriend
```
java.lang.String maxFriend
```
      存放该用户允许的最多好友个数。
      说明：本字段存放的是String表示的整数。详见数据字典中 “用户信息/MISSU_USERS”表的设计说明。
      
      从以下版本开始:
      
      2.0
    - userDesc
```
java.lang.String userDesc
```
      存放该用户的个人其它说明文字。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
      
      从以下版本开始:
      
      2.5
    - userType
```
java.lang.String userType
```
      存放该用户的用户类型（无符号整数）。
      本字段目前主要用于区分普通IM用户和公司运营后台用户。具体意义详见数据字典中表“用户信息/MISSU_USERS”中user_type字段的定义。
      
      从以下版本开始:
      
      2.5.1
    - user_uid
```
java.lang.String user_uid
```
      本字段为RainbowChat系统中的用户唯id，是全系统的唯一标识。
      无论用户登陆时使用什么（可能是邮件地址、手机号、或者直接像qq一样用唯一id号），此id在任何情况下都是一个用户的唯一合法身份标识。
      为配合RainbowChat升级MobileIMSDK v3时而增加，本对象如果是由登陆接口返回，则将随后与 RosterElementEntity.token 一起在返回到客户端后，分别作为loginUserId和loginToken 来登陆连接IM服务器之用。
    - user_mail
```
java.lang.String user_mail
```
      用户的邮箱地址。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
    - nickname
```
java.lang.String nickname
```
      用户的昵称。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
    - user_sex
```
java.lang.String user_sex
```
      用户的性别。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
    - register_time
```
java.lang.String register_time
```
      用户的注册时间。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
    - latest_login_time
```
java.lang.String latest_login_time
```
      实际存放的是数据库表missu_users中的latest_login_time2字段。
      说明：本字段存放的是String表示的long整数.
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
      
      从以下版本开始:
      
      2.0
    - latest_login_ip
```
java.lang.String latest_login_ip
```
      用户最近登陆ip。
      详见数据字典中“用户信息/MISSU_USERS”表的设计说明。
      
      从以下版本开始:
      
      4.5
    - liveStatus
```
int liveStatus
```
      用户的在线状态：0 表示不在线，1 表示在线
    - token
```
java.lang.String token
```
      用途1：用于IM的连接认证>
      为了接下来客户端对接IM即时通讯框架而生成的token，主要用于安全策略，具体生成和使用方法由逻辑层定义。本字段仅在从登陆接口返回时有意义，其它情况下无意义。
      截止20170216日止，本字段暂作保留字段，未来在架构优化和升级和，在服务端性能能得到保证的前提下再启用此token的验证不迟。
      本字段为配合RainbowChat升级MobileIMSDK v3时而增加，将与 RosterElementEntity.user_uid 一起在返回到客户端后，分别作为loginUserId和loginToken来登陆连接IM服务器之用。
      TODO 为了便于解偶和对接IM实时框架的理解，未来可以考虑将http的登际认证接口独立为SSO单点登陆接口，而与SSO接口配合使用会让MobileIMSDK v3的理解更为直观和简单。
      用途2：用于HTTP REST接口调用时的合法身份标识>
      基于HTTP REST接口调用的安全考虑，此token建议每次调用rest接口时带上，以便rest服务端检查此次rest 表求的合法性。
      
      从以下版本开始:
      
      4.0
    - friendRemark
```
java.lang.String friendRemark
```
      好友备注。
      注：本字段对应于数据库表“missu_roster”中的“remark”字段（详见数据库字典），当前仅用于客户端查询当前仅用于客户端查询好友列表数据时使用，其它情况下本字段无意义！
      
      从以下版本开始:
      
      7.3
    - friendMobileNum
```
java.lang.String friendMobileNum
```
      好友手机号。
      注：本字段对应于数据库表“missu_roster”中的“mobile_num”字段（详见数据库字典），当前仅用于客户端查询当前仅用于客户端查询好友列表数据时使用，其它情况下本字段无意义！
      
      从以下版本开始:
      
      7.3
    - friendMoreDesc
```
java.lang.String friendMoreDesc
```
      好友更多描述。
      注：本字段对应于数据库表“missu_roster”中的“more_desc”字段（详见数据库字典），当前仅用于客户端查询当前仅用于客户端查询好友列表数据时使用，其它情况下本字段无意义！
      
      从以下版本开始:
      
      7.3
    - friendPicFileName
```
java.lang.String friendPicFileName
```
      好友相关图片、名片（存放的是文件名，详见数据库字典中的字段说明）。
      注：本字段对应于数据库表“missu_roster”中的“pic_file_name”字段（详见数据库字典），当前仅用于客户端查询当前仅用于客户端查询好友列表数据时使用，其它情况下本字段无意义！
      
      从以下版本开始:
      
      7.3
- 类com.x52im.rainbowchat.http.logic.dto.UserRegisterDTO扩展java.lang.Object实现可序列化
  - 序列化字段
    - user_uid
```
java.lang.String user_uid
```
    - user_mail
```
java.lang.String user_mail
```
    - nickname
```
java.lang.String nickname
```
    - user_psw
```
java.lang.String user_psw
```
    - user_sex
```
java.lang.String user_sex
```
程序包 com.x52im.rainbowchat.im.dto
- 类com.x52im.rainbowchat.im.dto.CMDBody4MyselfBeInvitedGroupResponse扩展GroupEntity实现可序列化
  - 序列化字段
    - inviteBeUid
```
java.lang.String inviteBeUid
```
      邀请人的UID（此字段可为空，为空则表示并非邀请而是主动加入的）.
    - initveBeNickName
```
java.lang.String initveBeNickName
```
      邀请人的昵称（此字段可为空，为空则表示并非邀请而是主动加入的）.
- 类com.x52im.rainbowchat.im.dto.RevokedMeta扩展java.lang.Object实现可序列化
  - 序列化字段
    - uid
```
java.lang.String uid
```
      "撤回"者的uid
    - nickName
```
java.lang.String nickName
```
      "撤回"者的昵称
    - beUid
```
java.lang.String beUid
```
      被"撤回"者的uid。
      注：用于群聊时，由管理员撤回其它群员消息时存入被撤回消息的发送者uid，其它余情况下本参数为空！
    - beNickName
```
java.lang.String beNickName
```
      被"撤回"者的昵称。
      注：用于群聊时，由管理员撤回其它群员消息时存入被撤回消息的发送者uid，其它余情况下本参数为空！
    - fpForMessage
```
java.lang.String fpForMessage
```
      将要被撤回的消息的指纹码（也就是唯一ID啦）
    - originalContent
```
java.lang.String originalContent
```
      未撤回前的原始消内容（当前仅用于文本消息时，用于撤回后的"重新编辑"功能时使用）

序列化表格

程序包 com.eva.framework.dto

类com.eva.framework.dto.DataFromClient扩展java.lang.Object实现可序列化

序列化字段

doInput

processorId

jobDispatchId

actionId

newData

oldData

token

device

类com.eva.framework.dto.DataFromClient4Web扩展DataFromClient实现可序列化

序列化字段

format

jsoncallback

类com.eva.framework.dto.DataFromServer扩展java.lang.Object实现可序列化

序列化字段

success

returnValue

code

类com.eva.framework.dto.LoginInfo2扩展java.lang.Object实现可序列化

序列化字段

appKey

loginName

clientVersion

loginPsw

deviceInfo

osType

deviceID

程序包 com.x52im.rainbowchat.http.logic.dto

类com.x52im.rainbowchat.http.logic.dto.CosplayRes扩展java.lang.Object实现可序列化

序列化字段

res_id

res_name

res_human_size

res_size

flag_type

download_count

create_time

cover_pic_path

res_path

res_status

res_bz

类com.x52im.rainbowchat.http.logic.dto.GiftProcessResult扩展java.lang.Object实现可序列化

序列化字段

resultCode

resultValue

类com.x52im.rainbowchat.http.logic.dto.GroupEntity扩展java.lang.Object实现可序列化

序列化字段

g_id

g_status

g_name

g_owner_user_uid

g_notice

max_member_count

g_member_count

create_user_name

create_time

g_owner_name

nickname_ingroup

imIsInGroup

g_notice_updatetime

g_notice_updateuid

g_notice_updatenick

类com.x52im.rainbowchat.http.logic.dto.RosterElementEntity扩展java.lang.Object实现可序列化

序列化字段

ex1

ex10

ex11

ex12

ex13

ex14

ex15

mustVersion4A

mustVersionDesc4A

userAvatarFileName

whatsUp

maxFriend

userDesc