Struct ricq::client::Client

pub struct Client {
    pub online: AtomicBool,
    pub heartbeat_enabled: AtomicBool,
    pub account_info: RwLock<AccountInfo>,
    pub address: RwLock<AddressInfo>,
    pub online_clients: RwLock<Vec<OtherClientInfo>>,
    pub last_message_time: AtomicI64,
    pub start_time: i32,
    /* private fields */
}

Fields

online: AtomicBool

heartbeat_enabled: AtomicBool

account_info: RwLock<AccountInfo>

address: RwLock<AddressInfo>

online_clients: RwLock<Vec<OtherClientInfo>>

last_message_time: AtomicI64

start_time: i32

Implementations

impl Client

pub async fn get_friend_system_messages(&self) -> RQResult<FriendSystemMessages>

获取好友请求

pub async fn solve_friend_system_message(
    &self,
    msg_seq: i64,
    req_uin: i64,
    accept: bool
) -> RQResult<()>

处理好友申请

pub async fn _get_friend_list(
    &self,
    friend_start_index: i16,
    friend_list_count: i16,
    group_start_index: i16,
    group_list_count: i16
) -> RQResult<FriendListResponse>

获取好友列表 第一个参数offset，从0开始；第二个参数count，150，另外两个都是0

pub async fn delete_friend(&self, del_uin: i64) -> RQResult<()>

删除好友

Args

• del_uin 为要删除的好友QQid

Return

• 如果删除好友成功 返回 Ok(())
• 如果删除好友失败 返回 Err(RQError::Other)
• 其他异常 返回 Err(..)

pub async fn get_friend_list(&self) -> RQResult<FriendListResponse>

刷新好友列表

pub async fn friend_list_add_group(
    &self,
    sort_id: u8,
    group_name: String
) -> RQResult<()>

好友列表-添加好友分组

pub async fn friend_list_rename_group(
    &self,
    group_id: u8,
    group_name: String
) -> RQResult<()>

好友列表-重命名好友分组

pub async fn friend_list_del_group(&self, group_id: u8) -> RQResult<()>

好友列表-删除好友分组

pub async fn friend_poke(&self, target: i64) -> RQResult<()>

好友戳一戳

pub async fn send_friend_message(
    &self,
    target: i64,
    message_chain: MessageChain
) -> RQResult<MessageReceipt>

发送好友消息

pub async fn send_friend_audio(
    &self,
    target: i64,
    audio: FriendAudio
) -> RQResult<MessageReceipt>

发送好友语音

pub async fn upload_friend_image(
    &self,
    target: i64,
    data: Vec<u8>
) -> RQResult<FriendImage>

pub async fn _upload_friend_image(
    &self,
    upload_key: Vec<u8>,
    addr: SocketAddr,
    data: Vec<u8>
) -> RQResult<()>

pub async fn get_off_pic_store(
    &self,
    target: i64,
    image_info: &ImageInfo
) -> RQResult<OffPicUpResp>

pub async fn send_friend_music_share(
    &self,
    uin: i64,
    music_share: MusicShare,
    music_type: MusicType
) -> RQResult<()>

分享好友音乐

pub async fn recall_friend_message(
    &self,
    uin: i64,
    msg_time: i64,
    seqs: Vec<i32>,
    rands: Vec<i32>
) -> RQResult<()>

pub async fn upload_friend_audio(
    &self,
    target: i64,
    data: Vec<u8>,
    audio_duration: Duration
) -> RQResult<FriendAudio>

pub async fn get_friend_audio_url(
    &self,
    sender_uin: i64,
    audio: FriendAudio
) -> RQResult<String>

pub async fn mark_friend_message_readed(
    &self,
    uin: i64,
    time: i64
) -> RQResult<()>

标记私聊消息已读 TODO 待测试

pub async fn get_friend_rich_sig(
    &self,
    user_ids: Vec<i64>
) -> RQResult<Vec<RichSigInfo>>

获取好友个性签名

impl Client

pub async fn get_all_group_system_messages(
    &self
) -> RQResult<GroupSystemMessages>

获取所有进群请求

pub async fn solve_group_system_message(
    &self,
    msg_seq: i64,
    req_uin: i64,
    group_code: i64,
    suspicious: bool,
    is_invite: bool,
    accept: bool,
    block: bool,
    reason: String
) -> RQResult<()>

处理加群申请

pub async fn _get_group_list(
    &self,
    vec_cookie: &[u8]
) -> RQResult<GroupListResponse>

获取群列表 第一个参数offset，从0开始；第二个参数count，150，另外两个都是0

pub async fn send_group_message(
    &self,
    group_code: i64,
    message_chain: MessageChain
) -> RQResult<MessageReceipt>

发送群消息

pub async fn send_group_audio(
    &self,
    group_code: i64,
    group_audio: GroupAudio
) -> RQResult<MessageReceipt>

发送群语音

pub async fn send_group_temp_message(
    &self,
    group_code: i64,
    user_uin: i64,
    message_chain: MessageChain
) -> RQResult<MessageReceipt>

发送群成员临时消息

pub async fn get_group_member_info(
    &self,
    group_code: i64,
    uin: i64
) -> RQResult<GroupMemberInfo>

获取群成员信息

pub async fn get_group_infos(
    &self,
    group_codes: Vec<i64>
) -> RQResult<Vec<GroupInfo>>

批量获取群信息

pub async fn get_group_info(
    &self,
    group_code: i64
) -> RQResult<Option<GroupInfo>>

获取群信息

pub async fn get_group_list(&self) -> RQResult<Vec<GroupInfo>>

刷新群列表

pub async fn get_group_member_list(
    &self,
    group_code: i64,
    group_owner_uin: i64
) -> RQResult<Vec<GroupMemberInfo>>

获取群成员列表

pub async fn mark_group_message_readed(
    &self,
    group_code: i64,
    seq: i32
) -> RQResult<()>

标记群消息已读

pub async fn group_mute(
    &self,
    group_code: i64,
    member_uin: i64,
    duration: Duration
) -> RQResult<()>

群禁言 (解除禁言 duration=0)

pub async fn group_mute_all(&self, group_code: i64, mute: bool) -> RQResult<()>

全员禁言

pub async fn update_group_name(
    &self,
    group_code: i64,
    name: String
) -> RQResult<()>

修改群名称

pub async fn update_group_memo(
    &self,
    group_code: i64,
    memo: String
) -> RQResult<()>

设置群公告

pub async fn group_set_admin(
    &self,
    group_code: i64,
    member: i64,
    flag: bool
) -> RQResult<()>

设置群管理员

flag: true 设置管理员 false 取消管理员

pub async fn group_poke(&self, group_code: i64, target: i64) -> RQResult<()>

群戳一戳

pub async fn group_kick(
    &self,
    group_code: i64,
    member_uins: Vec<i64>,
    kick_msg: &str,
    block: bool
) -> RQResult<()>

群踢人

pub async fn group_invite(&self, group_code: i64, uin: i64) -> RQResult<()>

pub async fn group_quit(&self, group_code: i64) -> RQResult<()>

pub async fn group_at_all_remain(
    &self,
    group_code: i64
) -> RQResult<GroupAtAllRemainInfo>

获取群 @全体成员 剩余次数

pub async fn group_edit_special_title(
    &self,
    group_code: i64,
    member_uin: i64,
    new_title: String
) -> RQResult<()>

设置群头衔

pub async fn get_anony_info(
    &self,
    group_code: i64
) -> RQResult<Option<Anonymous>>

获取自己的匿名信息（用于发送群消息）

pub async fn send_group_music_share(
    &self,
    group_code: i64,
    music_share: MusicShare,
    music_type: MusicType
) -> RQResult<()>

分享群音乐

pub async fn edit_group_member_card(
    &self,
    group_code: i64,
    member_uin: i64,
    card: String
) -> RQResult<()>

修改群名片

pub async fn recall_group_message(
    &self,
    group_code: i64,
    seqs: Vec<i32>,
    rands: Vec<i32>
) -> RQResult<()>

撤回群消息

pub async fn get_group_image_store(
    &self,
    group_code: i64,
    image_info: &ImageInfo
) -> RQResult<GroupImageStoreResp>

pub async fn _upload_group_image(
    &self,
    upload_key: Vec<u8>,
    addr: SocketAddr,
    data: Vec<u8>
) -> RQResult<()>

pub async fn upload_group_image(
    &self,
    group_code: i64,
    data: Vec<u8>
) -> RQResult<GroupImage>

上传群图片

pub async fn upload_group_audio(
    &self,
    group_code: i64,
    data: Vec<u8>,
    codec: u32
) -> RQResult<GroupAudio>

上传群音频 codec: 0-amr, 1-silk

pub async fn get_group_audio_url(
    &self,
    group_code: i64,
    audio: GroupAudio
) -> RQResult<String>

pub async fn get_group_short_video_store(
    &self,
    short_video_upload_req: ShortVideoUploadReq
) -> RQResult<ShortVideoUploadRsp>

pub async fn upload_group_short_video(
    &self,
    group_code: i64,
    video_data: Vec<u8>,
    thumb_data: Vec<u8>
) -> RQResult<VideoFile>

上传群短视频 参数：群号，视频数据，封面数据 TODO 未来可能会改成输入 std::io::Read

pub async fn operate_group_essence(
    &self,
    group_code: i64,
    msg_seq: i32,
    msg_rand: i32,
    flag: bool
) -> RQResult<EacRspBody>

设置群精华消息

pub async fn send_group_long_message(
    &self,
    group_code: i64,
    message_chain: MessageChain
) -> RQResult<MessageReceipt>

发送群消息 仅在多张图片时需要，发送文字不需要

pub async fn send_group_forward_message(
    &self,
    group_code: i64,
    msgs: Vec<ForwardMessage>
) -> RQResult<MessageReceipt>

发送转发消息

pub async fn get_group_admin_list(
    &self,
    group_code: i64
) -> RQResult<HashMap<i64, GroupMemberPermission>>

获取群主/管理员列表

pub async fn group_sign_in(&self, group_code: i64) -> RQResult<()>

群聊打卡

impl Client

登录相关

pub async fn fetch_qrcode(&self) -> RQResult<QRCodeState>

二维码登录 - 获取二维码

pub async fn query_qrcode_result(&self, sig: &[u8]) -> RQResult<QRCodeState>

二维码登录 - 查询二维码状态

pub async fn qrcode_login(
    &self,
    tmp_pwd: &[u8],
    tmp_no_pic_sig: &[u8],
    tgt_qr: &[u8]
) -> RQResult<LoginResponse>

二维码登录 - 登录 ( 可能还需要 device_lock_login )

pub async fn password_md5_login(
    &self,
    uin: i64,
    password_md5: &[u8]
) -> RQResult<LoginResponse>

密码登录 - 提交密码md5

pub async fn password_login(
    &self,
    uin: i64,
    password: &str
) -> RQResult<LoginResponse>

pub async fn request_sms(&self) -> RQResult<LoginResponse>

密码登录 - 请求短信验证码

pub async fn submit_sms_code(&self, code: &str) -> RQResult<LoginResponse>

密码登录 - 提交短信验证码

pub async fn submit_ticket(&self, ticket: &str) -> RQResult<LoginResponse>

密码登录 - 提交滑块ticket

pub async fn device_lock_login(&self) -> RQResult<LoginResponse>

设备锁登录 - 二维码、密码登录都需要

pub async fn token_login(&self, token: Token) -> RQResult<LoginResponse>

token 登录

pub async fn request_change_sig(
    &self,
    main_sig_map: Option<u32>
) -> RQResult<LoginResponse>

换 token，使用后需要重新 register

pub async fn register_client(&self) -> RQResult<SvcRespRegister>

注册客户端，登录后必须注册

pub async fn heartbeat(&self) -> RQResult<()>

impl Client

API

pub async fn update_online_status<T>(&self, status: T) -> RQResult<()> where
    T: Into<Status>, 

设置在线状态 TODO net_type

pub async fn update_signature(&self, signature: String) -> RQResult<()>

修改签名

pub async fn update_profile_detail(
    &self,
    profile: ProfileDetailUpdate
) -> RQResult<()>

修改个人资料

pub async fn refresh_status(&self) -> RQResult<()>

刷新客户端状态

pub async fn get_allowed_clients(&self) -> RQResult<Vec<SvcDevLoginInfo>>

获取通过安全验证的设备

pub async fn translate(
    &self,
    src_language: String,
    dst_language: String,
    src_text_list: Vec<String>
) -> RQResult<Vec<String>>

文本翻译

pub async fn send_like(
    &self,
    uin: i64,
    count: i32,
    source: i32,
    cookies: Bytes
) -> RQResult<()>

pub async fn image_ocr(
    &self,
    img_url: String,
    md5: String,
    size: i32,
    wight: i32,
    height: i32
) -> RQResult<OcrResponse>

pub async fn delete_message(&self, items: Vec<MessageItem>) -> RQResult<()>

pub async fn delete_online_push(
    &self,
    uin: i64,
    svrip: i32,
    push_token: Bytes,
    seq: u16,
    del_msg: Vec<PushMessageInfo>
) -> RQResult<()>

pub async fn get_summary_info(&self, uin: i64) -> RQResult<SummaryCardInfo>

pub async fn upload_msgs(
    &self,
    group_code: i64,
    msgs: Vec<ForwardMessage>,
    is_long: bool
) -> RQResult<String>

pub async fn download_msgs(
    &self,
    res_id: String
) -> RQResult<Vec<ForwardMessage>>

pub async fn send_message(
    &self,
    routing_head: RoutingHead,
    message_chain: MessageChain,
    ptt: Option<Ptt>
) -> RQResult<MessageReceipt>

发送消息

impl Client

pub async fn highway_upload_bdh(
    &self,
    addr: SocketAddr,
    input: BdhInput
) -> RQResult<Bytes>

impl Client

pub fn get_address(&self) -> SocketAddr

pub fn get_status(&self) -> u8

pub async fn start<S: AsyncRead + AsyncWrite>(self: &Arc<Self>, stream: S)

pub fn stop(&self, status: NetworkStatus)

impl Client

pub async fn process_income_packet(self: &Arc<Self>, pkt: Packet)

impl Client

pub fn new<H>(device: Device, version: &'static Version, handler: H) -> Client where
    H: Handler + 'static + Sync + Send, 

pub fn new_with_config<H>(config: Config, handler: H) -> Self where
    H: Handler + 'static + Sync + Send, 

pub async fn uin(&self) -> i64

pub async fn send(&self, pkt: Packet) -> RQResult<usize>

pub async fn send_and_wait(&self, pkt: Packet) -> RQResult<Packet>

pub async fn do_heartbeat(&self)

pub async fn gen_token(&self) -> Token

pub async fn load_token(&self, token: Token)

pub async fn device(&self) -> Device

pub async fn version(&self) -> Version

pub async fn _get_highway_session_key(&self) -> Vec<u8>

Trait Implementations

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.