me.xuxiaoxiao.chatapi.wechat

类 WeChatClient

java.lang.Object

me.xuxiaoxiao.chatapi.wechat.WeChatClient

public final class WeChatClient
extends Object

模拟网页微信客户端

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WeChatClient.WeChatListener 模拟网页微信客户端监听器

字段概要

字段

限定符和类型	字段和说明
static String	CFG_PREFIX
static String	INIT_EXCEPTION
static String	LISTEN_EXCEPTION
static String	LOG_TAG
static String	LOGIN_EXCEPTION
static String	LOGIN_TIMEOUT
static int	STATUS_EXCEPTION
static int	STATUS_LOGOUT
static int	STATUS_PERMIT
static int	STATUS_READY
static int	STATUS_SCAN
static int	STATUS_WORKING

构造器概要

构造器

构造器和说明
WeChatClient()

方法概要

限定符和类型	方法和说明
void	dump() 打印Cookie和登录信息
void	editRemark(WXUser wxUser, String remark) 修改用户备注名
WXContact	fetchAvatar(WXContact wxContact) 获取用户头像
WXContact	fetchContact(String contactId) 获取用户联系人，如果获取的联系人是群组，则会自动获取群成员的详细信息 在联系人列表中获取到的群，没有群成员，可以通过这个方法，获取群的详细信息
WXFile	fetchFile(WXFile wxFile) 获取文件消息的附件文件
WXImage	fetchImage(WXImage wxImage) 获取图片消息的大图
WXVideo	fetchVideo(WXVideo wxVideo) 获取视频消息的视频文件
WXVoice	fetchVoice(WXVoice wxVoice) 获取语音消息的语音文件
WeChatClient.WeChatListener	getListener() 获取客户端的监听器
void	passVerify(WXVerify wxVerify) 同意好友申请
void	revokeMsg(WXMessage wxMessage) 撤回消息
WXMessage	sendFile(WXContact wxContact, File file) 发送文件消息，可以是图片，动图，视频，文本等文件
WXLocation	sendLocation(WXContact wxContact, String lon, String lat, String title, String lable) 发送位置消息 经纬度坐标可以通过腾讯坐标拾取工具获得(https://lbs.qq.com/tool/getpoint) 其拾取的坐标默认格式为 lat,lon
WXText	sendText(WXContact wxContact, String text) 发送文字消息
void	setGroupName(WXGroup wxGroup, String name) 修改聊天室名称
void	setListener(WeChatClient.WeChatListener listener) 设置客户端的监听器
void	shutdown() 关闭客户端，注意：关闭后的客户端不能再被启动
void	startup() 启动客户端，注意：一个客户端类的实例只能被启动一次
int	status() 获取客户端的状态
void	topContact(WXContact wxContact, boolean isTop) 设置联系人置顶状态
WXContact	userContact(String contactId) 根据联系人id获取用户联系人信息
WXUser	userFriend(String userId) 根据userId获取用户好友
HashMap<String,WXUser>	userFriends() 获取用户所有好友
WXGroup	userGroup(String groupId) 根据群id获取群信息
HashMap<String,WXGroup>	userGroups() 获取用户所有群
WXUser	userMe() 获取当前登录的用户信息

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

CFG_PREFIX

public static final String CFG_PREFIX

另请参阅:

常量字段值

LOG_TAG

public static final String LOG_TAG

另请参阅:

常量字段值

LOGIN_TIMEOUT

public static final String LOGIN_TIMEOUT

另请参阅:

常量字段值

LOGIN_EXCEPTION

public static final String LOGIN_EXCEPTION

另请参阅:

常量字段值

INIT_EXCEPTION

public static final String INIT_EXCEPTION

另请参阅:

常量字段值

LISTEN_EXCEPTION

public static final String LISTEN_EXCEPTION

另请参阅:

常量字段值

STATUS_EXCEPTION

public static final int STATUS_EXCEPTION

另请参阅:

常量字段值

STATUS_READY

public static final int STATUS_READY

另请参阅:

常量字段值

STATUS_SCAN

public static final int STATUS_SCAN

另请参阅:

常量字段值

STATUS_PERMIT

public static final int STATUS_PERMIT

另请参阅:

常量字段值

STATUS_WORKING

public static final int STATUS_WORKING

另请参阅:

常量字段值

STATUS_LOGOUT

public static final int STATUS_LOGOUT

另请参阅:

常量字段值

构造器详细资料

WeChatClient

public WeChatClient()

方法详细资料

dump

public void dump()

打印Cookie和登录信息

setListener

public void setListener(@Nonnull
                        WeChatClient.WeChatListener listener)

设置客户端的监听器

参数:

listener - 监听器对象

getListener

@Nullable
public WeChatClient.WeChatListener getListener()

获取客户端的监听器

返回:

监听器对象

startup

public void startup()

启动客户端，注意：一个客户端类的实例只能被启动一次

status

public int status()

获取客户端的状态

返回:

客户端的当前状态

shutdown

public void shutdown()

关闭客户端，注意：关闭后的客户端不能再被启动

userMe

public WXUser userMe()

获取当前登录的用户信息

返回:

当前登录的用户信息

userFriend

@Nullable
public WXUser userFriend(@Nonnull
                                    String userId)

根据userId获取用户好友

参数:

userId - 好友的id

返回:

好友的信息

userFriends

@Nonnull
public HashMap<String,WXUser> userFriends()

获取用户所有好友

返回:

用户所有好友

userGroup

@Nullable
public WXGroup userGroup(@Nonnull
                                    String groupId)

根据群id获取群信息

参数:

groupId - 群id

返回:

群信息

userGroups

@Nonnull
public HashMap<String,WXGroup> userGroups()

获取用户所有群

返回:

用户所有群

userContact

@Nullable
public WXContact userContact(@Nonnull
                                        String contactId)

根据联系人id获取用户联系人信息

参数:

contactId - 联系人id

返回:

联系人信息

sendText

@Nonnull
public WXText sendText(@Nonnull
                                 WXContact wxContact,
                                 @Nonnull
                                 String text)

发送文字消息

参数:

wxContact - 目标联系人

text - 要发送的文字

返回:

文本消息

sendFile

@Nullable
public WXMessage sendFile(@Nonnull
                                     WXContact wxContact,
                                     @Nonnull
                                     File file)

发送文件消息，可以是图片，动图，视频，文本等文件

参数:

wxContact - 目标联系人

file - 要发送的文件

返回:

图像或附件消息

sendLocation

@Nonnull
public WXLocation sendLocation(@Nonnull
                                         WXContact wxContact,
                                         @Nonnull
                                         String lon,
                                         @Nonnull
                                         String lat,
                                         @Nonnull
                                         String title,
                                         @Nonnull
                                         String lable)

发送位置消息

经纬度坐标可以通过腾讯坐标拾取工具获得(https://lbs.qq.com/tool/getpoint) 其拾取的坐标默认格式为 lat,lon

参数:

wxContact - 目标联系人

lon - 经度

lat - 纬度

title - 定位消息模块标题

lable - 定位消息模块二级描述

返回:

定位消息

fetchContact

@Nullable
public WXContact fetchContact(@Nonnull
                                         String contactId)

获取用户联系人，如果获取的联系人是群组，则会自动获取群成员的详细信息 在联系人列表中获取到的群，没有群成员，可以通过这个方法，获取群的详细信息

参数:

contactId - 联系人id

返回:

联系人的详细信息

fetchAvatar

@Nonnull
public WXContact fetchAvatar(@Nonnull
                                       WXContact wxContact)

获取用户头像

参数:

wxContact - 要获取头像文件的用户

返回:

获取头像文件后的用户

fetchImage

@Nonnull
public WXImage fetchImage(@Nonnull
                                    WXImage wxImage)

获取图片消息的大图

参数:

wxImage - 要获取大图的图片消息

返回:

获取大图后的图片消息

fetchVoice

@Nonnull
public WXVoice fetchVoice(@Nonnull
                                    WXVoice wxVoice)

获取语音消息的语音文件

参数:

wxVoice - 语音消息

返回:

获取语音文件后的语音消息

fetchVideo

@Nonnull
public WXVideo fetchVideo(@Nonnull
                                    WXVideo wxVideo)

获取视频消息的视频文件

参数:

wxVideo - 视频消息

返回:

获取视频文件后的视频消息

fetchFile

@Nonnull
public WXFile fetchFile(@Nonnull
                                  WXFile wxFile)

获取文件消息的附件文件

参数:

wxFile - 文件消息

返回:

获取附件文件后的文件消息

revokeMsg

public void revokeMsg(@Nonnull
                      WXMessage wxMessage)

撤回消息

参数:

wxMessage - 需要撤回的微信消息

passVerify

public void passVerify(@Nonnull
                       WXVerify wxVerify)

同意好友申请

参数:

wxVerify - 好友验证消息

editRemark

public void editRemark(@Nonnull
                       WXUser wxUser,
                       @Nonnull
                       String remark)

修改用户备注名

参数:

wxUser - 目标用户

remark - 备注名称

topContact

public void topContact(@Nonnull
                       WXContact wxContact,
                       boolean isTop)

设置联系人置顶状态

参数:

wxContact - 需要设置置顶状态的联系人

isTop - 是否置顶

setGroupName

public void setGroupName(@Nonnull
                         WXGroup wxGroup,
                         @Nonnull
                         String name)

修改聊天室名称

参数:

wxGroup - 目标聊天室

name - 目标名称