X5 API
Class

Im ($UI/chat/base/js/im)

使用范围：UI2

Contents

class Im ($UI/chat/base/js/im)

IM前端JS接口

Constructor Top

  Im ()

Methods Top

Object addFriend (Person person)
void addLike (Peer peer, String rid)
void addPerson (Person person)
void autoLogin (Object param)
void bindDialogs (fucntion callback)
void bindGroup (int gid, fucntion callback)
void bindUser (int uid, function callback)
void bindUserOnline (int uid, fucntion callback)
Object clearChat (Peer peer)
Object deleteChat (Peer peer)
Object deleteMessage (Peer peer, String rid)
void editGroupAbout (String string)
void editGroupTitle (int gid, String title)
void editMyAbout (String string)
Object emojiParse ()
Object existFriend (Person person)
Person getCurrentPerson ()
String getCurrentPersonID ()
Object getGroup (int gid)
String getGroupDefaultIcon ()
Object getOrgDepts (String id)
Object getOrgPersons (String id)
Person getPerson (String id)
Person getPersonByUID (int uid)
String getPersonDefaultIcon ()
void getUid ()
Object getUser (int uid)
Object inviteMember (int gid, int uid)
void isLoggedIn (Person person)
void kickMember (Peer peer, String rid)
Object login (Object param)
Object loginActor ()
void logout ()
Object messageParse ()
void onChatEnd (Peer peer)
void onConversationClosed (Peer peer)
void onConversationOpen (Peer peer)
void onDialogsEnd ()
void onLoggedIn ()
Object regPerson (Person person)
void sendClipboardPhotoMessage (Peer peer, Object photo)
void sendPhotoMessage (Peer peer, Object file)
void sendTextMessage (Peer peer, String text)
void sendTextMessageToPerson (Person person, String text)
void sendVoiceMessage (Peer peer, int duration, Object voice)
void setReady (Boolean ok)
void unbindDialogs (fucntion callback)
void unbindUserOnline (int uid, fucntion callback)
void updateGroupShared (int gid, String groupShared)

Constructor details Top

public Im ()

IM前端JS接口

Methods Detail Top

public Object addFriend (Person person)

帮组织人员在dangchat-server中注册并与组织人员在dangchat-server中成为好友关系。聊天和创建群聊邀请成员都需要成为好友关系

Parameters

Person person

组织人员的person对象

Return Value

Object

promise 参考JavaScript的promise对象

IM.addFriend(person).done(function(uid){ 帮助组织人员注册并在dangchat-server中成为好友关系和返回注册人员的uid })

public void addLike (Peer peer, String rid)

消息添加关注

Parameters

Peer peer

人员或群组的peer对象
String rid

消息id

Return Value

void

public void addPerson (Person person)

组织人员增加时,增加组织人员的前端person对象数组

Parameters

Person person

组织人员的person对象

Return Value

void

public void autoLogin (Object param)

自动登录,取Store中保存登录成功的信息

Parameters

Object param

保存登录信息的对象,登录名和密码。

Return Value

void

public void bindDialogs (fucntion callback)

获取绑定会话列表,获取推送消息

 
	 
		IM.bindDialogs(function(dialogs){
			//会话列表数组
		})

Parameters

fucntion callback

回调函数

Return Value

void

public void bindGroup (int gid, fucntion callback)

绑定群组信息

Parameters

int gid

群组在dangchat-server中的id
fucntion callback

回调函数,当群组信息发生变化时dangchat-server会推送过来

Return Value

void

public void bindUser (int uid, function callback)

绑定联系人信息

Parameters

int uid

组织人员在dangchat-server中的id,
function callback

回调函数,当人员信息发生变化时dangchat-server会推送过来

Return Value

void

public void bindUserOnline (int uid, fucntion callback)

绑定人员的在线状态

Parameters

int uid

人员的uid
fucntion callback

回调函数,获取人员的在线状态

Return Value

void

public Object clearChat (Peer peer)

清空与联系人或群组的所有聊天消息

Parameters

Peer peer

人员或群组的peer对象,推送的会话列表中可取到

Return Value

Object

promise 参考JavaScript的promise对象

public Object deleteChat (Peer peer)

删除会话

Parameters

Peer peer

人员或群组的peer对象,推送的会话列表中可取到

Return Value

Object

promise 参考JavaScript的promise对象

public Object deleteMessage (Peer peer, String rid)

清空与联系人或群组的所有聊天消息

Parameters

Peer peer

人员或群组的peer对象
String rid

消息的id,可在推送的消息内容中取到

Return Value

Object

promise 参考JavaScript的promise对象

public void editGroupAbout (String string)

群主修改群介绍

Parameters

String string

字符串

Return Value

void

public void editGroupTitle (int gid, String title)

群主修改群名称

Parameters

int gid

群组id
String title

群组名称

Return Value

void

public void editMyAbout (String string)

修改个人的介绍

Parameters

String string

字符串

Return Value

void

public Object emojiParse ()

解析emoji表情

Return Value

Object

public Object existFriend (Person person)

判断组织中人员和登录人是否为好友关系

Parameters

Person person

组织人员的person对象

Return Value

Object

promise 参考JavaScript的promise对象

IM.existFriend(person).done(function(exist){ exist为boolean类型。返回和组织人员在dangchat-server是否为好友关系 });

public Person getCurrentPerson ()

获取当前登录人员的person对象

Return Value

Person

person对象

public String getCurrentPersonID ()

获取当前登录人员ID

Return Value

String

id 当前登录人id

public Object getGroup (int gid)

群组信息

Parameters

int gid

群组在dangchat-server中的id

Return Value

Object

public String getGroupDefaultIcon ()

获取群组默认头像

Return Value

String

头像路径

public Object getOrgDepts (String id)

获取组织下的所有部门(需使用者自己实现)

Parameters

String id

当前登录人员id

Return Value

Object

promise 参考JavaScript的promise对象

IM.getOrgDepts(id).done{function(orgDepts){ orgDepts是当前登录人所在组织的所有部门 }}

public Object getOrgPersons (String id)

获取组织下的所有人(需使用者自己实现)

Parameters

String id

当前登录人的ID

Return Value

Object

promise 具体参考JavaScript的promise对象
promise完成时返回参数

IM.getOrgPersons(id).done(function(org){ org是当前登录人所在组织的所有人员 })

public Person getPerson (String id)

根据组织人员的uid取组织人员的person对象

Parameters

String id

组织ID

Return Value

Person

person对象

public Person getPersonByUID (int uid)

根据组织人员的uid取组织人员的person对象

Parameters

int uid

组织人员UID

Return Value

Person

person对象

public String getPersonDefaultIcon ()

获取人员默认头像

Return Value

String

头像路径

public void getUid ()

得到登录人的uid

Return Value

void

public Object getUser (int uid)

得到联系人信息

Parameters

int uid

组织人员在dangchat-server中的id

Return Value

Object

public Object inviteMember (int gid, int uid)

邀请群成员

Parameters

int gid

群组id
int uid

人员uid

Return Value

Object

promise 参考JavaScript的promise对象

public void isLoggedIn (Person person)

组织人员增加时,增加组织人员的前端person对象数组

Parameters

Person person

组织人员的person对象

Return Value

void

public void kickMember (Peer peer, String rid)

群主删除群成员

Parameters

Peer peer

人员或群组的peer对象
String rid

消息id

Return Value

void

public Object login (Object param)

登录X5逻辑,登录成功后保存成功信息

Parameters

Object param

保存登录信息的对象(登录名和密码)

param.userName param.password

Return Value

Object

promise

IM.login(param).done(function(data){ data是登录成功后返回的信息 })

public Object loginActor ()

登录dangchat-server,组织人员第一次登录时,组织人员在dangchat-server中注册并返回注册人员的uid

Return Value

Object

promise 参考JavaScript的promise对象

IM.loginActor.done(function(){ //登录dangchat-server成功 })

public void logout ()

登出X5逻辑,dangchat-server没有退出,次方法中将本地缓存清空,实现dangchat-server退出

Return Value

void

public Object messageParse ()

消息解析,根据消息的类型对消息进行处理,展示不同的形式。图片、声音等。

Return Value

Object

public void onChatEnd (Peer peer)

获取更多消息。调用一次推二十条历史消息

Parameters

Peer peer

联系人或群组的peer对象

Return Value

void

public void onConversationClosed (Peer peer)

关闭与联系人的链接,离开消息页面时要关闭,否则进入新会话页面时不会清空会话列表中的未读消息数。

Parameters

Peer peer

联系人或群组的peer对象

Return Value

void

public void onConversationOpen (Peer peer)

打开与联系人的链接,将会话列表中的未读消息数设置为零

Parameters

Peer peer

联系人或群组的peer对象

Return Value

void

public void onDialogsEnd ()

获取更多会话。调用一次推二十条历史会话

Return Value

void

public void onLoggedIn ()

登录X5成功后派发的事件"onLoggedIn"

Return Value

void

public Object regPerson (Person person)

注册功能,帮助组织人员注册dangchat-server获取组织人员uid

Parameters

Person person

组织人员的person对象

Return Value

Object

promise 参考JavaScript的promise对象

IM.regPerson(person).done(function(uid){ 返回注册人员的uid })

public void sendClipboardPhotoMessage (Peer peer, Object photo)

发送剪切板中图片

Parameters

Peer peer

组织人员在dangchat-server中保存的对象
Object photo

图片文件

Return Value

void

public void sendPhotoMessage (Peer peer, Object file)

发送图片消息

Parameters

Peer peer

组织人员在dangchat-server中保存的对象
Object file

文件对象

Return Value

void

public void sendTextMessage (Peer peer, String text)

发送文本消息

Parameters

Peer peer

组织人员在dangchat-server中保存的对象
String text

文本消息内容

Return Value

void

public void sendTextMessageToPerson (Person person, String text)

发送消息(人员)

Parameters

Person person

组织人员的person对象
String text

消息内容

Return Value

void

public void sendVoiceMessage (Peer peer, int duration, Object voice)

发送音频消息

Parameters

Peer peer

组织人员在dangchat-server中保存的对象
int duration

时长
Object voice

声音文件

Return Value

void

public void setReady (Boolean ok)

wex5铛铛新注册人员登录后选择组织,加入组织成功后进行注册并登录dangchat-server操作

Parameters

Boolean ok

是否完成注册人员

Return Value

void

public void unbindDialogs (fucntion callback)

解绑会话列表,断开推送

Parameters

fucntion callback

回调函数

Return Value

void

public void unbindUserOnline (int uid, fucntion callback)

解绑人员的在线状态

Parameters

int uid

人员的uid
fucntion callback

回调函数

Return Value

void

public void updateGroupShared (int gid, String groupShared)

群主的共享群设置,新加入群成员是否能够看到历史消息。

Parameters

int gid

群组id
String groupShared

"#|$,1"为开启群共享,"#|$,0"为关闭群共享

Return Value

void