kovi-onebot 0.13.0

OneBot V11 protocol driver for Kovi bot framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
use kovi::RuntimeBot;
use kovi::bot::runtimebot::{
    CanSendApi, send_api_await_response, send_api_request, send_api_request_with_forget,
    send_api_request_with_response,
};
use kovi::bot::{ApiReturn, SendApi};
#[cfg(not(feature = "cqstring"))]
use kovi::message::Message as KoviMessage;
use log::info;
use serde::Serialize;
use serde_json::{Value, json};

#[cfg(feature = "cqstring")]
use crate::onebot_message::CQMessage;
#[cfg(not(feature = "cqstring"))]
use crate::onebot_message::OneBotMessage;

pub enum HonorType {
    All,
    Talkative,
    Performer,
    Legend,
    StrongNewbie,
    Emotion,
}

pub enum AddRequestType<'a> {
    Type(&'a str),
    SubType(&'a str),
}

/// Kovi提供解析过的返回值的api
pub trait OnebotTrait: CanSendApi {
    ///发送群组消息, 并返回消息ID
    #[cfg(not(feature = "cqstring"))]
    fn send_group_msg_return<T>(
        &self,
        group_id: i64,
        msg: T,
    ) -> impl std::future::Future<Output = Result<i32, ApiReturn>>
    where
        KoviMessage: From<T>,
        T: Serialize,
    {
        let msg = KoviMessage::from(msg);
        let group_id = &group_id;
        info!("[send] [to group {group_id}]: {}", msg.to_human_string());

        let msg = OneBotMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({
                "message_type":"group",
                "group_id":group_id,
                "message":msg,
                "auto_escape":true,
            }),
        );

        let api_rx = send_api_request(self.__get_api_tx(), send_api);

        async move {
            let r = send_api_await_response(api_rx).await;

            match r {
                Ok(v) => match v.data.get("message_id").and_then(|v| v.as_i64()) {
                    Some(b) => Ok(b as i32),
                    None => Err(v),
                },

                Err(v) => Err(v),
            }
        }
    }

    ///发送群组消息, 并返回消息ID
    #[cfg(feature = "cqstring")]
    fn send_group_msg_return<T>(
        &self,
        group_id: i64,
        msg: T,
    ) -> impl std::future::Future<Output = Result<i32, ApiReturn>>
    where
        CQMessage: From<T>,
        T: Serialize,
    {
        let msg = CQMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({
                "message_type":"group",
                "group_id":group_id,
                "message":msg,
                "auto_escape":false,
            }),
        );

        let group_id = &group_id;
        info!(
            "[send] [to group {group_id}]: {}",
            Message::from(msg).to_human_string()
        );

        let api_rx = send_api_request(&self.__get_api_tx(), send_api);

        async move {
            let r = send_api_await_response(api_rx).await;
            match r {
                Ok(v) => match v.data.get("message_id").and_then(|v| v.as_i64()) {
                    Some(b) => Ok(b as i32),
                    None => Err(v),
                },

                Err(v) => Err(v),
            }
        }
    }

    #[cfg(not(feature = "cqstring"))]
    ///发送私聊消息, 并返回消息ID
    fn send_private_msg_return<T>(
        &self,
        user_id: i64,
        msg: T,
    ) -> impl std::future::Future<Output = Result<i32, ApiReturn>>
    where
        KoviMessage: From<T>,
        T: Serialize,
    {
        let send_api = SendApi::new(
            "send_msg",
            json!({"message_type":"private",
                "user_id":user_id,
                "message":msg,
                "auto_escape":true,}),
        );

        let msg = KoviMessage::from(msg);
        let user_id = &user_id;
        info!("[send] [to private {user_id}]: {}", msg.to_human_string());

        let api_rx = send_api_request(self.__get_api_tx(), send_api);

        async move {
            let r = send_api_await_response(api_rx).await;

            match r {
                Ok(v) => match v.data.get("message_id").and_then(|v| v.as_i64()) {
                    Some(b) => Ok(b as i32),
                    None => Err(v),
                },

                Err(v) => Err(v),
            }
        }
    }

    #[cfg(feature = "cqstring")]
    ///发送私聊消息, 并返回消息ID
    fn send_private_msg_return<T>(
        &self,
        user_id: i64,
        msg: T,
    ) -> impl std::future::Future<Output = Result<i32, ApiReturn>>
    where
        CQMessage: From<T>,
        T: Serialize,
    {
        let msg = CQMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({"message_type":"private",
                "user_id":user_id,
                "message":msg,
                "auto_escape":false,}),
        );

        let user_id = &user_id;
        info!(
            "[send] [to private {user_id}]: {}",
            Message::from(msg).to_human_string()
        );

        let api_rx = send_api_request(&self.__get_api_tx(), send_api);

        async move {
            let r = send_api_await_response(api_rx).await;
            match r {
                Ok(v) => match v.data.get("message_id").and_then(|v| v.as_i64()) {
                    Some(b) => Ok(b as i32),
                    None => Err(v),
                },

                Err(v) => Err(v),
            }
        }
    }

    /// 是否能发送图片
    fn can_send_image(&self) -> impl std::future::Future<Output = Result<bool, ApiReturn>> {
        let send_api = SendApi::new("can_send_image", json!({}));

        let api_rx = send_api_request(self.__get_api_tx(), send_api);

        async move {
            let r = send_api_await_response(api_rx).await;
            match r {
                Ok(v) => match v.data.get("yes").and_then(|v| v.as_bool()) {
                    Some(b) => Ok(b),
                    None => Err(v),
                },

                Err(v) => Err(v),
            }
        }
    }

    /// 是否能发送语音
    fn can_send_record(&self) -> impl std::future::Future<Output = Result<bool, ApiReturn>> {
        let send_api = SendApi::new("can_send_record", json!({}));

        let api_rx = send_api_request(self.__get_api_tx(), send_api);

        async move {
            let r = send_api_await_response(api_rx).await;
            match r {
                Ok(v) => match v.data.get("yes").and_then(|v| v.as_bool()) {
                    Some(b) => Ok(b),
                    None => Err(v),
                },

                Err(v) => Err(v),
            }
        }
    }

    #[cfg(not(feature = "cqstring"))]
    ///发送群组消息,如果需要返回消息id,请使用send_group_msg_return()
    fn send_group_msg<T>(&self, group_id: i64, msg: T)
    where
        KoviMessage: From<T>,
        T: Serialize,
    {
        let msg = KoviMessage::from(msg);
        let group_id = &group_id;
        info!("[send] [to group {group_id}]: {}", msg.to_human_string());

        let msg = OneBotMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({
                    "message_type":"group",
                    "group_id":group_id,
                    "message":msg,
                    "auto_escape":true,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    #[cfg(feature = "cqstring")]
    ///发送群组消息,如果需要返回消息id,请使用send_group_msg_return()
    fn send_group_msg<T>(&self, group_id: i64, msg: T)
    where
        CQMessage: From<T>,
        T: Serialize,
    {
        let msg = CQMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({
                    "message_type":"group",
                    "group_id":group_id,
                    "message":msg,
                    "auto_escape":false,
            }),
        );
        let group_id = &group_id;
        info!(
            "[send] [to group {group_id}]: {}",
            Message::from(msg).to_human_string()
        );
        send_api_request_with_forget(&self.__get_api_tx(), send_api);
    }

    #[cfg(not(feature = "cqstring"))]
    ///发送私聊消息,如果需要返回消息id,请使用send_private_msg_return()
    fn send_private_msg<T>(&self, user_id: i64, msg: T)
    where
        KoviMessage: From<T>,
        T: Serialize,
    {
        let msg = KoviMessage::from(msg);
        let user_id = &user_id;
        info!("[send] [to private {user_id}]: {}", msg.to_human_string());

        let msg = OneBotMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({
                "message_type":"private",
                    "user_id":user_id,
                    "message":msg,
                    "auto_escape":true,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    #[cfg(feature = "cqstring")]
    ///发送私聊消息,如果需要返回消息id,请使用send_private_msg_return()
    fn send_private_msg<T>(&self, user_id: i64, msg: T)
    where
        CQMessage: From<T>,
        T: Serialize,
    {
        let msg = CQMessage::from(msg);
        let send_api = SendApi::new(
            "send_msg",
            json!({
                "message_type":"private",
                    "user_id":user_id,
                    "message":msg,
                    "auto_escape":false,
            }),
        );

        let user_id = &user_id;
        info!(
            "[send] [to private {user_id}]: {}",
            Message::from(msg).to_human_string()
        );
        send_api_request_with_forget(&self.__get_api_tx(), send_api);
    }

    /// 撤回消息
    ///
    /// # Arguments
    ///
    /// `message_id`: 消息 ID
    fn delete_msg(&self, message_id: i32) {
        let send_api = SendApi::new(
            "delete_msg",
            json!({
                "message_id":message_id,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 点赞,有些服务端会返回点赞失败,所以需要返回值的话请使用 send_like_return()
    /// # Arguments
    ///
    /// `user_id`
    ///
    /// `times`: 次数
    fn send_like(&self, user_id: i64, times: usize) {
        let send_api = SendApi::new(
            "send_like",
            json!({
                                "user_id":user_id,
                    "times":times,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 群组踢人
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `user_id`
    ///
    /// `reject_add_request`: 是否拒绝此人的加群请求,传入true则拒绝
    fn set_group_kick(&self, group_id: i64, user_id: i64, reject_add_request: bool) {
        let send_api = SendApi::new(
            "set_group_kick",
            json!({
                "group_id":group_id,
                    "user_id":user_id,
                    "reject_add_request":reject_add_request,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 群组单人禁言
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `user_id`
    ///
    /// `duration`: 禁言时长,单位秒,0 表示取消禁言
    fn set_group_ban(&self, group_id: i64, user_id: i64, duration: usize) {
        let send_api = SendApi::new(
            "set_group_ban",
            json!({
                "group_id":group_id,
                    "user_id":user_id,
                    "duration":duration,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }
    /// 群组匿名用户禁言
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `anonymous`: 要禁言的匿名用户对象(群消息上报的 anonymous 字段)
    ///
    /// `enable`: 是否禁言
    fn set_group_anonymous_ban_use_anonymous(
        &self,
        group_id: i64,
        anonymous: Value,
        duration: usize,
    ) {
        let send_api = SendApi::new(
            "set_group_anonymous_ban",
            json!({
                "group_id":group_id,
                    "anonymous":anonymous,
                    "duration":duration,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }
    /// 群组匿名用户禁言
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `flag`: 要禁言的匿名用户的 flag(需从群消息上报的数据中获得)
    ///
    /// `enable`: 是否禁言
    fn set_group_anonymous_ban_use_flag(&self, group_id: i64, flag: &str, duration: usize) {
        let send_api = SendApi::new(
            "set_group_anonymous_ban",
            json!({
                "group_id":group_id,
                    "flag":flag,
                    "duration":duration,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 群组全员禁言
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `enable`: 是否禁言
    fn set_group_whole_ban(&self, group_id: i64, enable: bool) {
        let send_api = SendApi::new(
            "set_group_whole_ban",
            json!({
                "group_id":group_id,
                    "enable":enable,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 群组设置管理员
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `user_id`
    ///
    /// `enable`: true 为设置,false 为取消
    fn set_group_admin(&self, group_id: i64, user_id: i64, enable: bool) {
        let send_api = SendApi::new(
            "set_group_admin",
            json!({
                "group_id":group_id,
                    "user_id":user_id,
                    "enable":enable,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }
    /// 群组匿名
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `enable`: true 为设置,false 为取消
    fn set_group_anonymous(&self, group_id: i64, enable: bool) {
        let send_api = SendApi::new(
            "set_group_anonymous",
            json!({
                "group_id":group_id,
                    "enable":enable,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 设置群名片(群备注)
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `user_id`
    ///
    /// `card`: 群名片内容,不填或空字符串表示删除群名片
    fn set_group_card(&self, group_id: i64, user_id: i64, card: &str) {
        let send_api = SendApi::new(
            "set_group_card",
            json!({
                "group_id":group_id,
                    "user_id":user_id,
                    "card":card,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 设置群名
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `group_name`: 新群名
    fn set_group_name(&self, group_id: i64, group_name: &str) {
        let send_api = SendApi::new(
            "set_group_name",
            json!({
                "group_id":group_id,
                    "group_name":group_name,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 退出群组
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `is_dismiss`: 是否解散,如果登录号是群主,则仅在此项为 true 时能够解散
    fn set_group_leave(&self, group_id: i64, is_dismiss: bool) {
        let send_api = SendApi::new(
            "set_group_leave",
            json!({
                "group_id":group_id,
                    "is_dismiss":is_dismiss,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 设置群组专属头衔
    ///
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `user_id`
    ///
    /// `special_title`: 专属头衔,空字符串表示删除专属头衔
    fn set_group_special_title(&self, group_id: i64, user_id: i64, special_title: &str) {
        let send_api = SendApi::new(
            "set_group_special_title",
            json!({
                "group_id":group_id,
                    "user_id":user_id,
                    "special_title":special_title,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }
    /// 处理加好友请求
    ///
    /// # Arguments
    ///
    /// `flag`: 加好友请求的 flag(需从上报的数据中获得)
    ///
    /// `approve`: 是否同意请求
    ///
    /// `remark`: 添加后的好友备注(仅在同意时有效)
    fn set_friend_add_request(&self, flag: &str, approve: bool, remark: &str) {
        let send_api = SendApi::new(
            "set_friend_add_request",
            json!({
                "flag":flag,
                    "approve":approve,
                    "remark":remark,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }
    /// 处理加群请求/邀请
    ///
    /// # Arguments
    ///
    /// `flag`: 加群请求的 flag(需从上报的数据中获得)
    ///
    /// `type`: add 或 invite,请求类型(需要和上报消息中的 sub_type 或 type 字段相符),由于不同服务端实现不一样,Kovi 提供一个枚举,使用需注意服务端要求是 sub_type 还是 type
    ///
    /// `approve`: 是否同意请求/邀请
    ///
    /// `remark`: 可为空, 拒绝理由(仅在拒绝时有效)
    fn set_group_add_request(
        &self,
        flag: &str,
        type_: AddRequestType,
        approve: bool,
        reason: &str,
    ) {
        let (type_, type_value) = match type_ {
            AddRequestType::SubType(v) => ("sub_type", v),
            AddRequestType::Type(v) => ("type", v),
        };
        let send_api = SendApi::new(
            "set_group_add_request",
            json!({
                "flag":flag,
                    type_: type_value,
                    "approve":approve,
                    "reason":reason,
            }),
        );

        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }

    /// 清理缓存
    ///
    /// 用于清理积攒了太多的**OneBot服务端**缓存文件。**并非是对于本框架清除**。
    fn clean_cache(&self) {
        let send_api = SendApi::new("clean_cache", json!({}));
        send_api_request_with_forget(self.__get_api_tx(), send_api);
    }
    // //////////////////////////////
    // 这些是需要处理返回值的api
    // //////////////////////////////

    /// 获取消息
    /// # Arguments
    ///
    /// `message_id`: 消息ID
    fn get_msg(
        &self,
        message_id: i32,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_msg",
            json!({
                "message_id":message_id
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取合并转发消息
    /// # Arguments
    ///
    /// `id`: 合并转发 ID
    fn get_forward_msg(
        &self,
        id: &str,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_forward_msg",
            json!({
                "id":id
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取获取登录号信息
    fn get_login_info(&self) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new("get_login_info", json!({}));

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取获取陌生人信息
    /// # Arguments
    ///
    /// `user_id`
    ///
    /// `no_cache`: 是否不使用缓存(使用缓存可能更新不及时,但响应更快)
    fn get_stranger_info(
        &self,
        user_id: i64,
        no_cache: bool,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_stranger_info",
            json!({
                    "user_id":user_id,
                    "no_cache":no_cache
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取好友列表
    fn get_friend_list(&self) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new("get_friend_list", json!({}));

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取群信息
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `no_cache`: 是否不使用缓存(使用缓存可能更新不及时,但响应更快)
    fn get_group_info(
        &self,
        group_id: i64,
        no_cache: bool,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_group_info",
            json!({
                    "group_id":group_id,
                    "no_cache":no_cache
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取群列表
    fn get_group_list(&self) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new("get_group_list", json!({}));

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    ///获取群成员信息
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `user_id`
    ///
    /// `no_cache`: 是否不使用缓存(使用缓存可能更新不及时,但响应更快)
    fn get_group_member_info(
        &self,
        group_id: i64,
        user_id: i64,
        no_cache: bool,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_group_member_info",
            json!({
                "group_id":group_id,
                    "user_id":user_id,
                    "no_cache":no_cache
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取群成员列表
    ///
    /// # Arguments
    ///
    /// `group_id`
    fn get_group_member_list(
        &self,
        group_id: i64,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_group_member_list",
            json!({
                "group_id":group_id,
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }

    /// 获取群荣誉信息
    /// # Arguments
    ///
    /// `group_id`
    ///
    /// `honor_type`: 要获取的群荣誉类型,可传入 talkative performer legend strong_newbie emotion 以分别获取单个类型的群荣誉数据,或传入 all 获取所有数据。**本框架已包装好了HonorType枚举**
    fn get_group_honor_info(
        &self,
        group_id: i64,
        honor_type: HonorType,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let honor_type = match honor_type {
            HonorType::All => "all",
            HonorType::Talkative => "talkative",
            HonorType::Performer => "performer",
            HonorType::Legend => "legend",
            HonorType::StrongNewbie => "strong_newbie",
            HonorType::Emotion => "emotion",
        };

        let send_api = SendApi::new(
            "get_group_honor_info",
            json!({
                "group_id":group_id,
                    "type":honor_type
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }

    /// 获取相关接口凭证, 即 Cookies 和 CSRF Token 的合并。
    ///
    /// # Arguments
    ///
    /// `domain`: 需要获取 cookies 的域名
    fn get_credentials(
        &self,
        domain: &str,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_credentials",
            json!({
                "domain":domain,
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }

    /// 获取运行状态
    fn get_status(&self) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new("get_status", json!({}));

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取版本信息
    fn get_version_info(&self) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new("get_version_info", json!({}));
        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取 Cookies
    ///
    /// # Arguments
    ///
    /// `domain`: 需要获取 cookies 的域名
    fn get_cookies(
        &self,
        domain: &str,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_cookies",
            json!({
                "domain":domain,
            }),
        );
        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取 CSRF Token
    fn get_csrf_token(&self) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new("get_csrf_token", json!({}));

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取语音
    ///
    /// # Arguments
    ///
    /// `file`: 收到的语音文件名(消息段的 file 参数),如 `0B38145AA44505000B38145AA4450500.silk`
    ///
    /// `out_format`: 要转换到的格式,目前支持 `mp3`、`amr`、`wma`、`m4a`、`spx`、`ogg`、`wav`、`flac`
    fn get_record(
        &self,
        file: &str,
        out_format: &str,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_record",
            json!({
                "file":file,
                    "out_format":out_format
            }),
        );
        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
    /// 获取图片
    ///
    /// # Arguments
    ///
    /// `file`: 收到的图片文件名(消息段的 file 参数),如 `6B4DE3DFD1BD271E3297859D41C530F5.jpg`
    fn get_image(
        &self,
        file: &str,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "get_image",
            json!({
                "file":file,
            }),
        );
        send_api_request_with_response(self.__get_api_tx(), send_api)
    }

    /// 点赞,有些服务端会返回点赞失败,不关注返回值的话请使用 send_like()
    /// # Arguments
    ///
    /// `user_id`
    ///
    /// `times`: 次数
    fn send_like_return(
        &self,
        user_id: i64,
        times: usize,
    ) -> impl std::future::Future<Output = Result<ApiReturn, ApiReturn>> {
        let send_api = SendApi::new(
            "send_like",
            json!({
                                "user_id":user_id,
                    "times":times,
            }),
        );

        send_api_request_with_response(self.__get_api_tx(), send_api)
    }
}

impl OnebotTrait for RuntimeBot {
}