public abstract class IYWContactService extends Object
| Constructor and Description |
|---|
IYWContactService() |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
ackAddContact(String userId,
String appKey,
boolean yes,
String msgConfirm,
IWxCallback callback)
回应添加联系人好友请求
|
abstract void |
addBlackContact(String userId,
String appKey,
IWxCallback result)
添加到黑名单
|
abstract void |
addContact(String userId,
String appKey,
String remarkName,
String msg,
IWxCallback callback)
添加联系人好友
|
abstract void |
addContactCacheUpdateListener(IYWContactCacheUpdateListener listener)
注册联系人缓存更新监听
具体方法请看
IYWContactCacheUpdateListener |
abstract void |
addContactOperateNotifyListener(IYWContactOperateNotifyListener listener)
注册联系人操作事件通知
具体方法请看
IYWContactOperateNotifyListener |
abstract void |
addProfileUpdateListener(IContactProfileUpdateListener listener)
添加用户Profile更新监听
|
abstract void |
asynchronousSyncContactsToCacheAndDB(List<IYWDBContact> contacts,
IWxCallback result)
异步地将联系人好友同步到云旺的Cache和DB
|
abstract void |
chgContactRemark(String userId,
String appKey,
String remarkName,
IWxCallback result)
修改联系人好友备注名
|
abstract void |
clearAllContactInfoCache()
清除用户Profile信息(昵称、头像等)的缓存
|
abstract void |
clearContactInfoCache(String userId,
String appkey)
清除某个指定用户Profile信息(昵称、头像等)的缓存
|
abstract void |
delContact(String userId,
String appKey,
IWxCallback callback)
删除联系人好友
|
static void |
enableBlackList()
开启黑名单功能,如果需要使用黑名单功能,请务必调用该方法,否则黑名单功能无效
|
abstract void |
fetchCrossUserProfile(List<IYWContact> contacts,
IWxCallback callback)
获取跨域的带域profile信息
|
abstract void |
fetchUserProfile(List<String> uids,
String appkey,
IWxCallback callback)
获取带域profile信息
|
abstract void |
fetchUserProfiles(List<String> uids,
IWxCallback callback)
获取当前域用户的profile信息
|
abstract IYWContactHeadClickCallback |
getContactHeadClickCallback()
NOT FOR OPENIM
获得头像点击的回调
|
abstract IYWContactProfileCallback |
getContactProfileCallback()
NOT FOR OPENIM
获取当前设置的profile信息回调
|
abstract IYWContact |
getContactProfileInfo(String userId,
String appkey)
获取用户昵称和头像信息,如果用户通过setContactProfileCallback或者setCrossContactProfileCallback
方法设置了callback,此方法会直接调用用户设置的回调。如果没有设置,则SDK会向服务器做请求处理
|
abstract List<IYWContact> |
getContactProfileInfos(List<String> userIds,
String appkey)
获取用户昵称和头像信息,如果用户通过setContactProfileCallback或者setCrossContactProfileCallback
方法设置了callback,此方法会直接调用用户设置的回调。如果没有设置,则SDK会向服务器做请求处理
|
abstract long |
getContactsChangeTimeStamp()
获取当前联系人变化的时间戳(每次变化的时候都会更新,用于主动比较是否需要更新联系人UI,主动更新UI)
|
abstract List<IYWDBContact> |
getContactsFromCache()
从cache获取联系人好友(由于不同账号的DB不同,因此无需担心串号问题)
|
abstract IYWCrossContactProfileCallback |
getCrossContactProfileCallback()
NOT FOR OPENIM
获取当前设置的跨域消息互通profile信息回调
|
abstract List<IYWContact> |
getCrossContactProfileInfos(List<IYWContact> contacts)
获取跨域用户昵称和头像信息列表,如果用户通过setContactProfileCallback或者setCrossContactProfileCallback
方法设置了callback,此方法会直接调用用户设置的回调。如果没有设置,则SDK会向服务器做请求处理
|
abstract IYWContactProfileCallback |
getDeveloperDefineContactProfileCallback()
NOT FOR OPENIM
获取当前开发者设置的本地profile信息回调
|
abstract IYWCrossContactProfileCallback |
getDeveloperDefineCrossContactProfileCallback()
NOT FOR OPENIM
获取当前开发者设置的本地跨域消息互通profile信息回调
|
abstract int |
getMsgRecFlagForContact(IYWContact contact)
获取针对某一联系人contact的消息接收配置
|
abstract int |
getMsgRecFlagForContact(String userId,
String appKey)
获取针对某一联系人contact的消息接收配置,适用于调用时无法获取联系人
IYWContact对象 |
abstract void |
getMsgRecFlagForContactFromServer(String userId,
String appKey,
int timeout,
IWxCallback callback)
获取针对某一联系人contact的消息接收配置,适用于调用时无法获取联系人
IYWContact对象 |
abstract YWRichContentContact |
getRichContentContact(String userId,
String appkey)
获取带有更丰富信息的联系人实例(如联系人备注,如联系人Profile信息等)
|
abstract void |
getWXIMContact(IYWContact contact,
IWxCallback callback)
从服务端获取旺信联系人信息
|
abstract IYWContact |
getWXIMContact(String targetId)
获取聊天对象的信息
|
abstract IYWContact |
getWXIMContact(String appKey,
String targetId)
获取聊天对象的信息
|
abstract boolean |
isBlackContact(String userId,
String appKey)
该用户是否在黑名单中
|
static boolean |
isBlackListEnable()
黑名单功能是否已开启
|
abstract void |
notifyContactProfileUpdate()
Deprecated.
该方法已废弃,后续请使用
notifyContactProfileUpdate(String, String) |
abstract void |
notifyContactProfileUpdate(String userid,
String appkey)
通知个人Profile有更新,如果开发者是异步获取个人信息,获取成功后,请调用此方法,
让SDK及时刷新用户信息(昵称,头像)
|
abstract void |
registerContactsListener(IContactListListener contactCallback)
Deprecated.
|
abstract void |
removeBlackContact(String userId,
String appKey,
IWxCallback result)
移出黑名单
|
abstract void |
removeContactCacheUpdateListener(IYWContactCacheUpdateListener listener)
移除联系人缓存更新监听
具体方法请看
IYWContactCacheUpdateListener |
abstract void |
removeContactOperateNotifyListener(IYWContactOperateNotifyListener listener)
移除联系人操作事件通知
具体方法请看
IYWContactOperateNotifyListener |
abstract void |
removeProfileUpdateListener(IContactProfileUpdateListener listener)
移除
addProfileUpdateListener(IContactProfileUpdateListener)添加的监听器,当不再需要该监听器时调用该方法移除 |
abstract void |
setContactHeadClickCallback(IYWContactHeadClickCallback contactHeadClickCallback)
Deprecated.
|
abstract void |
setContactHeadClickListener(IYWContactHeadClickListener listener)
设置头像点击事件
|
abstract void |
setContactMsgRecType(IYWContact contact,
int msgRecType,
int timeout,
IWxCallback callback)
设置联系人消息接收类型
|
abstract void |
setContactProfileCallback(IYWContactProfileCallback mContactProfileCallback)
Deprecated.
|
abstract void |
setCrossContactProfileCallback(IYWCrossContactProfileCallback crossContactProfileCallback)
设置当前的跨域消息互通pprofile信息回调
|
abstract void |
syncBlackContacts(IWxCallback result)
获取黑名单列表
|
abstract void |
syncContacts(IWxCallback callback)
同步联系人好友
|
abstract void |
syncContactsOnlineStatus(List<IYWContact> contacts,
IWxCallback result)
请求联系人在线状态
|
abstract void |
syncCrossContactsOnlineStatus(List<IYWContact> contacts,
IWxCallback result)
NOT FOR OPENIM
请求跨域联系人在线状态
|
abstract void |
unRegisterContactsListener(IContactListListener contactCallback)
Deprecated.
|
abstract void |
updateContactSystemMessage(YWSystemMessage message)
更新联系人好友添加相关的系统消息
|
abstract void |
updateProfileInfo(String appkey,
YWProfileInfo profileInfo)
更新个人信息
|
abstract void |
updateProfileInfoToServer(YWProfileInfo profileInfo,
IWxCallback callback)
更新个人信息到Server
|
public static void enableBlackList()
public static boolean isBlackListEnable()
public abstract void fetchUserProfiles(List<String> uids, IWxCallback callback)
uids - uid列表, 去前缀的短idcallback - 获取数据的回调,如果成功,返回Listpublic abstract void fetchUserProfile(List<String> uids, String appkey, IWxCallback callback)
appkey - 应用appkeyuids - uid列表, 去前缀的短idcallback - 获取数据的回调,如果成功,返回Listpublic abstract void fetchCrossUserProfile(List<IYWContact> contacts, IWxCallback callback)
contacts - 必须设置userid和appkey, 请使用YWContactFactory.createAPPContact(String, String)创建IYWContact实例callback - 获取数据的回调,如果成功,返回Listpublic abstract void syncBlackContacts(IWxCallback result)
result - onSuccess(Object... obj){ Listpublic abstract void addBlackContact(String userId, String appKey, IWxCallback result)
userId - 被加入黑名单的用户idappKey - 被加入黑名单的用户的appKeyresult - onSuccess(Object... result) {IYWContact iywContact = (IYWContact) result[0]} 方式获得加入黑名单的用户public abstract void removeBlackContact(String userId, String appKey, IWxCallback result)
userId - 去前缀的短useridappKey - 应用appkeyresult - onSuccess(Object... result) {IYWContact iywContact = (IYWContact) result[0]} 方式获得移出黑名单的用户public abstract boolean isBlackContact(String userId, String appKey)
userId - 去前缀的短useridappKey - 应用appkeypublic abstract void syncContactsOnlineStatus(List<IYWContact> contacts, IWxCallback result)
contacts - 必须设置userid和appkey, 请使用YWContactFactory.createAPPContact(String, String)创建IYWContact实例result - 注意:回调运行在主线程,即UI线程
onSuccess(Object... result) {Mappublic abstract void syncCrossContactsOnlineStatus(List<IYWContact> contacts, IWxCallback result)
contacts - 必须设置userid和appkey, 请使用YWContactFactory.createAPPContact(String, String)创建IYWContact实例result - 注意:回调运行在主线程,即UI线程
onSuccess(Object... result) {Mappublic abstract IYWContactHeadClickCallback getContactHeadClickCallback()
public abstract void setContactHeadClickCallback(IYWContactHeadClickCallback contactHeadClickCallback)
setContactHeadClickListener(IYWContactHeadClickListener)contactHeadClickCallback - 头像点击回调public abstract void setContactHeadClickListener(IYWContactHeadClickListener listener)
listener - 头像点击事件public abstract IYWContactProfileCallback getContactProfileCallback()
public abstract IYWContactProfileCallback getDeveloperDefineContactProfileCallback()
public abstract void setContactProfileCallback(IYWContactProfileCallback mContactProfileCallback)
setCrossContactProfileCallback(IYWCrossContactProfileCallback)public abstract IYWCrossContactProfileCallback getCrossContactProfileCallback()
public abstract IYWCrossContactProfileCallback getDeveloperDefineCrossContactProfileCallback()
public abstract void setCrossContactProfileCallback(IYWCrossContactProfileCallback crossContactProfileCallback)
crossContactProfileCallback - 设置用户信息回调public abstract void asynchronousSyncContactsToCacheAndDB(List<IYWDBContact> contacts, IWxCallback result)
contacts - 实现了IYWDBContact的实例result - 执行结果回调,执行成功会调用IWxCallback.onSuccess(Object... result)public abstract List<IYWDBContact> getContactsFromCache()
@Deprecated public abstract void registerContactsListener(IContactListListener contactCallback)
addContactCacheUpdateListener(com.alibaba.mobileim.contact.IYWContactCacheUpdateListener)contactCallback - @Deprecated public abstract void unRegisterContactsListener(IContactListListener contactCallback)
removeContactCacheUpdateListener(com.alibaba.mobileim.contact.IYWContactCacheUpdateListener)contactCallback - public abstract void notifyContactProfileUpdate()
notifyContactProfileUpdate(String, String)public abstract void notifyContactProfileUpdate(String userid, String appkey)
userid - 用户idappkey - 用户的appKeypublic abstract IYWContact getWXIMContact(String targetId)
targetId - 聊天对象idpublic abstract IYWContact getWXIMContact(String appKey, String targetId)
appKey - 聊天对象APPEKYtargetId - 聊天对象idpublic abstract void getWXIMContact(IYWContact contact, IWxCallback callback)
contact - callback - public abstract void updateProfileInfo(String appkey, YWProfileInfo profileInfo)
appkey - 用户的appkeyprofileInfo - 用户的Profilepublic abstract void updateProfileInfoToServer(YWProfileInfo profileInfo,
IWxCallback callback)
profileInfo - 用户的Profilepublic abstract IYWContact getContactProfileInfo(String userId, String appkey)
userId - 用户useridappkey - 用户的appkeypublic abstract List<IYWContact> getContactProfileInfos(List<String> userIds, String appkey)
userIds - 用户userid列表appkey - 用户的appkeypublic abstract List<IYWContact> getCrossContactProfileInfos(List<IYWContact> contacts)
contacts - 必须设置userid和appkey, 请使用YWContactFactory.createAPPContact(String, String)创建IYWContact实例,或已传入包含userid和appkey的IYWContactpublic abstract int getMsgRecFlagForContact(IYWContact contact)
contact - 当前登录用户的联系人YWProfileSettingsConstants#RECEIVE_PEER_MSG:正常接收消息
YWProfileSettingsConstants#RECEIVE_PEER_MSG_NOT_REMIND:接收消息不提醒
setContactMsgRecType(IYWContact, int, int, IWxCallback)public abstract int getMsgRecFlagForContact(String userId, String appKey)
IYWContact对象userId - 联系人IdappKey - 联系人的appKeyYWProfileSettingsConstants#RECEIVE_PEER_MSG:正常接收消息
YWProfileSettingsConstants#RECEIVE_PEER_MSG_NOT_REMIND:接收消息不提醒
setContactMsgRecType(IYWContact, int, int, IWxCallback)public abstract void getMsgRecFlagForContactFromServer(String userId, String appKey, int timeout, IWxCallback callback)
IYWContact对象userId - 联系人IdappKey - 联系人的appKeytimeout - 超时时长callback - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),其参数为ArrayList<YWPeerSettingsModel>格式的可变参数,开发者可以使用(ArrayList<YWPeerSettingsModel>)result[0]获取结果
否则回调IWxCallback.onError(int, String)
注:设置请参考setContactMsgRecType(IYWContact, int, int, IWxCallback)public abstract void setContactMsgRecType(IYWContact contact, int msgRecType, int timeout, IWxCallback callback)
contact - 代表要设置的联系人对象msgRecType - 消息接收类型
YWProfileSettingsConstants#RECEIVE_PEER_MSG:正常接收消息
YWProfileSettingsConstants#RECEIVE_PEER_MSG_NOT_REMIND:接收消息不提醒
timeout - 超时时长callback - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),
否则回调IWxCallback.onError(int, String)
asynchronousSyncContactsToCacheAndDB(List, IWxCallback))public abstract void syncContacts(IWxCallback callback)
callback - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),onSuccess参数为空
否则回调IWxCallback.onError(int, String)public abstract void addContact(String userId, String appKey, String remarkName, String msg, IWxCallback callback)
userId - 联系人IdappKey - 联系人的appKeyremarkName - 好友备注 可选msg - 验证信息callback - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),onSuccess参数为空
否则回调IWxCallback.onError(int, String)public abstract void delContact(String userId, String appKey, IWxCallback callback)
userId - 联系人IdappKey - 联系人的appKeycallback - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),
解析方式:
----------------------------------------------
if (result != null && result.length > 0) {
IYWContact iywContact = (IYWContact) result[0];
.....
}
-----------------------------------------------
否则回调IWxCallback.onError(int, String)public abstract void ackAddContact(String userId, String appKey, boolean yes, String msgConfirm, IWxCallback callback)
userId - 联系人IdappKey - 联系人的appKeyyes - 是否同意 true:同意 false:拒绝msgConfirm - 回应时带上的消息callback - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),onSuccess参数为空
否则回调IWxCallback.onError(int, String)public abstract void chgContactRemark(String userId, String appKey, String remarkName, IWxCallback result)
userId - 联系人IdappKey - 联系人的appKeyremarkName - 联系人的备注名result - 操作结果回调,成功则回调IWxCallback.onSuccess(Object... result),onSuccess参数为空
否则回调IWxCallback.onError(int, String)public abstract void updateContactSystemMessage(YWSystemMessage message)
message - 用于更新的系统消息public abstract void addContactOperateNotifyListener(IYWContactOperateNotifyListener listener)
IYWContactOperateNotifyListenerlistener - 事件监听回调public abstract void removeContactOperateNotifyListener(IYWContactOperateNotifyListener listener)
IYWContactOperateNotifyListenerlistener - 事件监听回调public abstract void addContactCacheUpdateListener(IYWContactCacheUpdateListener listener)
IYWContactCacheUpdateListenerlistener - 事件监听回调public abstract void removeContactCacheUpdateListener(IYWContactCacheUpdateListener listener)
IYWContactCacheUpdateListenerlistener - 事件监听回调public abstract long getContactsChangeTimeStamp()
public abstract YWRichContentContact getRichContentContact(String userId, String appkey)
userId - 用户Idappkey - 用户的appKeypublic abstract void clearContactInfoCache(String userId, String appkey)
userId - 用户Idappkey - 用户的appKeypublic abstract void clearAllContactInfoCache()
public abstract void addProfileUpdateListener(IContactProfileUpdateListener listener)
listener - 用户Profile信息更新监听器,当有联系人Profile信息更新时调用回调方法IContactProfileUpdateListener#onProfileUpdate(String, String)public abstract void removeProfileUpdateListener(IContactProfileUpdateListener listener)
addProfileUpdateListener(IContactProfileUpdateListener)添加的监听器,当不再需要该监听器时调用该方法移除listener - 用户Profile信息更新监听器