-
Notifications
You must be signed in to change notification settings - Fork 45
/
index.js
1521 lines (1394 loc) · 62.4 KB
/
index.js
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
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
NativeModules,
Platform,
DeviceEventEmitter
} from 'react-native';
const JMessageModule = NativeModules.JMessageModule;
const listeners = {};
const receiveMsgEvent = "JMessage.ReceiveMsgEvent"; // 接收到消息事件
const receiptMsgEvent = "JMessage.ReceiptMsgEvent"; // 接收已读消息回执事件
const loginStateChanged = "JMessage.LoginStateChanged"; //
const clickMessageNotificationEvent = "JMessage.ClickMessageNotification"; // 点击推送 Android Only
const syncOfflineMessage = "JMessage.SyncOfflineMessage" // 同步离线消息事件
const syncRoamingMessage = "JMessage.SyncRoamingMessage" // 同步漫游消息事件
const messageRetract = "JMessage.MessageRetract" // 消息撤回事件
const contactNotify = "JMessage.ContactNotify" // 收到好友请求消息事件
const uploadProgress = "JMessage.UploadProgress" // 收到好友请求消息事件
const conversationChange = "JMessage.conversationChange" // 会话变更事件
const chatRoomMsgEvent = "JMessage.ReceiveChatRoomMsgEvent"; // 收到聊天室消息事件
const CommandNotificationEvent = "JMessage.CommandNotificationEvent"; // 收到聊天室消息事件
const receiveApplyJoinGroupApprovalEvent = "JMessage.ReceiveApplyJoinGroupApprovalEvent" // 接收到入群申请
const receiveGroupAdminRejectEvent = "JMessage.ReceiveGroupAdminRejectEvent" // 接收到管理员拒绝入群申请
const receiveGroupAdminApprovalEvent = "JMessage.ReceiveGroupAdminApprovalEvent" // 接收到管理员同意入群申请
export default class JMessage {
/**
* @param {object} params = {
* 'appkey': String, // 极光官网注册的应用 AppKey
* 'isOpenMessageRoaming': boolean, // 是否开启消息漫游,不传默认关闭。
* 'isProduction': Boolean, // 是否为生产模式
* 'channel': String // (选填)应用的渠道名称
* }
*
* 打开消息漫游之后,用户多个设备之间登录时,SDK 会自动将当前登录用户的历史消息同步到本地。
*/
static init(params) {
JMessageModule.setup(params)
}
/**
* 设置是否开启 debug 模式,开启后 SDK 将会输出更多日志信息。应用对外发布时应关闭。
*
* @param {object} params = {'enable': Boolean}
*/
static setDebugMode(params) {
// exec(null, null, PLUGIN_NAME, 'setDebugMode', [params])
JMessageModule.setDebugMode(params)
}
/**
* @param {object} params = {'username': String, 'password': String}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static register(params, success, error) {
JMessageModule.userRegister(params, success, error)
}
/**
* @param {object} params = {'username': String, 'password': String}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static login(params, success, error) {
// exec(success, error, PLUGIN_NAME, 'userLogin', [params])
JMessageModule.login(params, success, error)
}
/**
* 用户登出接口,调用后用户将无法收到消息。登出动作必定成功,开发者不需要关心结果回调。
*
* @param {function} success = function () {}
*/
static logout() {
JMessageModule.logout()
}
/**
* 登录成功则返回用户信息,已登出或未登录则对应用户信息为空对象。
*
* @param {function} success = function (myInfo) {}
*/
static getMyInfo(success) {
JMessageModule.getMyInfo(success);
}
/**
* 获取用户信息,此接口可用来获取不同 appKey 下用户的信息,如果 appKey 为空,则默认获取当前 appKey 下的用户信息。
*
* @param {object} params = {'username': String, 'appKey': String}
* @param {function} success = function (userInfo) {} // 通过参数返回用户对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getUserInfo(params, success, error) {
JMessageModule.getUserInfo(params, success, error)
}
/**
* @param {object} params = {'oldPwd': String, 'newPwd': String}
*/
static updateMyPassword(params, success, error) {
JMessageModule.updateMyPassword(params, success, error)
}
/**
* 更新当前用户头像。
*
* @param {object} params = {
* imgPath: string // 本地图片绝对路径。
* }
* 注意 Android 与 iOS 的文件路径是不同的:
* - Android 类似:/storage/emulated/0/DCIM/Camera/IMG_20160526_130223.jpg
* - iOS 类似:/var/mobile/Containers/Data/Application/7DC5CDFF-6581-4AD3-B165-B604EBAB1250/tmp/photo.jpg
*/
static updateMyAvatar(params, success, error) {
JMessageModule.updateMyAvatar(params, success, error)
}
/**
* 更新当前登录用户的信息。
*
* @param {object} params = {'field': '需要更新的字段值'}
*
* field 包括:nickname(昵称), birthday(生日), signature(签名), gender(性别), region(地区), address(具体地址),extras (附加信息)。
* 如:{
* 'birthday': Number, // 生日日期的微秒数
* 'gender': String, // 'male' / 'female' / 'unknown'
* 'extras': {String: String} // 附加字段
* ... // 其余皆为 String 类型
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static updateMyInfo(params, success, error) {
JMessageModule.updateMyInfo(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'messageType': String, // 'text', 'image', 'voice', 'location', 'file', 'custom'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'text': String, // Optional 消息内容
* 'path': String // Optional 资源路径
* 'fileName': String, // Optional 文件名
* 'latitude': Number, // Optional 纬度信息
* 'longitude': Number, // Optional 经度信息
* 'scale': Number, // Optional 地图缩放比例
* 'address': String, // Optional 详细地址信息
* 'customObject': {'key1': 'value1'} // Optional. Optional 自定义键值对
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'groupAt' : Object // 赋值则具有群@功能(only android 需要type为'group')
* 'usernames': stringArray // 需要@的人,不传则@全部(only android, 'atMe','atAll在收到消息的callback中返回)
* }
* @param {function} callback = function (msg) {} // 以参数形式返回消息对象。
*/
static createSendMessage(params, callback) {
JMessageModule.createSendMessage(params, callback);
}
/**
* only ios
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'messageType': String, // 'text', 'image', 'voice', 'location', 'file', 'custom'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'text': String, // Optional 消息内容
* 'path': String // Optional 资源路径
* 'fileName': String, // Optional 文件名
* 'latitude': Number, // Optional 纬度信息
* 'longitude': Number, // Optional 经度信息
* 'scale': Number, // Optional 地图缩放比例
* 'address': String, // Optional 详细地址信息
* 'customObject': {'key1': 'value1'} // Optional. Optional 自定义键值对
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'usernames': stringArray // 需要@的人,不传则@全部 ('atMe','atAll在收到消息的callback中返回)
* }
* @param {function} callback = function (msg) {} // 以参数形式返回消息对象。
*/
static sendGroupAtMessage(params, success, error){
if(Platform.OS === "ios"){
JMessageModule.sendGroupAtMessage(params,success,error)
}
}
/**
* @param {object} params = {
* 'id': String, // message id
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendMessage(params, success, error) {
JMessageModule.sendMessage(params, success, error);
}
/**
* 消息转发。
* 注意:只能转发消息状态为 SendSucceed 和 ReceiveSucceed 的消息。
* @param {object} params = {
* 'id': String, // message id
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'target': Object (User or Group) // 转发的对象,
* > 如果 target 是 user : {'type': 'user','username': string, appKey: string}, appkey 缺省时为应用 Appkey,
* > 如果 target 是 group: {'type': 'group','id': string }
*
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static forwardMessage(params, success, error) {
JMessageModule.sendMessage(params, success, error);
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'text': String, // 消息内容
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendTextMessage(params, success, error) {
JMessageModule.sendTextMessage(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'path': String, // 本地图片路径
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendImageMessage(params, success, error) {
JMessageModule.sendImageMessage(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'path': String, // 本地图片路径
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendVoiceMessage(params, success, error) {
JMessageModule.sendVoiceMessage(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'path': String, // 本地视频路径
* 'name': String, // 本地视频名
* 'thumbPath': String, // 本地视频缩略图路径
* 'format': String, // 本地视频缩略图格式
* 'duration': int, // 本地视频播放时长
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendVideoMessage(params, success, error) {
JMessageModule.sendVideoMessage(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'customObject': {'key1': 'value1'} // Optional. 自定义键值对
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendCustomMessage(params, success, error) {
JMessageModule.sendCustomMessage(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空
* 'username': String, // 当 type = single 时,username 不能为空
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'latitude': Number, // 纬度信息
* 'longitude': Number, // 经度信息
* 'scale': Number, // 地图缩放比例
* 'address': String, // 详细地址信息
* 'extras': Object // Optional. 自定义键值对 = {'key1': 'value1'}
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendLocationMessage(params, success, error) {
JMessageModule.sendLocationMessage(params, success, error)
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空。
* 'username': String, // 当 type = single 时,username 不能为空。
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'path': String, // 本地文件路径。
* 'extras': Object, // Optional. 自定义键值对 = {'key1': 'value1'}
* 'messageSendingOptions': MessageSendingOptions // Optional. MessageSendingOptions 对象。
* }
* @param {function} success = function (msg) {} // 以参数形式返回消息对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendFileMessage(params, success, error) {
JMessageModule.sendFileMessage(params, success, error)
}
/**
* 消息撤回。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空。
* 'username': String, // 当 type = single 时,username 不能为空。
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'messageId': String // 消息 id。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static retractMessage(params, success, error) {
JMessageModule.retractMessage(params, success, error)
}
/**
* 从最新的消息开始获取历史消息。
* 当 from = 0 && limit = =1 时,返回所有历史消息。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空。
* 'username': String, // 当 type = single 时,username 不能为空。
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'from': Number, // 开始的消息下标。
* 'limit': Number // 要获取的消息数。比如当 from = 0, limit = 10 时,是获取第 0 - 9 条历史消息。
* 'isDescend': Bool // 2.3.5 新增。如果设置为 true,则返回的消息列表按照时间降序排列,反之,按照时间顺序排列。
* }
* @param {function} success = function (messageArray)) {} // 以参数形式返回历史消息对象数组
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getHistoryMessages(params, success, error) {
JMessageModule.getHistoryMessages(params, success, error)
}
/**
*
* 根据messageId删除消息
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 当 type = group 时,groupId 不能为空。
* 'username': String, // 当 type = single 时,username 不能为空。
* 'appKey': String, // 当 type = single 时,用于指定对象所属应用的 appKey。如果为空,默认为当前应用。
* 'messageId': String // 消息 id。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static deleteMessage(params,success,error){
JMessageModule.deleteMessage(params,success,error)
}
/**
* 发送好友请求。
*
* @param {object} params = {
* 'username': String, // 对方用户用户名。
* 'appKey': String, // 对方用户所属应用的 AppKey。
* 'reason': String // 申请原因。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static sendInvitationRequest(params, success, error) {
JMessageModule.sendInvitationRequest(params, success, error)
}
/**
* @param {object} params = {
* 'username': String, // 对方用户用户名。
* 'appKey': String, // 对方用户所属应用的 AppKey。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static acceptInvitation(params, success, error) {
JMessageModule.acceptInvitation(params, success, error)
}
/**
* @param {object} params = {
* 'username': String, // 对方用户用户名。
* 'appKey': String, // 对方用户所属应用的 AppKey。
* 'reason': String // 拒绝原因。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static declineInvitation(params, success, error) {
JMessageModule.declineInvitation(params, success, error)
}
/**
* @param {object} params = {
* 'username': String, // 好友用户名。
* 'appKey': String, // 好友所属应用的 AppKey。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static removeFromFriendList(params, success, error) {
JMessageModule.removeFromFriendList(params, success, error)
}
/**
* @param {object} params = {
* 'username': String, // 好友用户名。
* 'appKey': String, // 好友所属应用的 AppKey。
* 'noteName': String // 备注名。
* }
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static updateFriendNoteName(params, success, error) {
JMessageModule.updateFriendNoteName(params, success, error)
}
/**
* @param {object} params = {
* 'username': String, // 好友用户名。
* 'appKey': String, // 好友所属应用的 AppKey。
* 'noteName': String // 备注信息。
* }
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static updateFriendNoteText(params, success, error) {
JMessageModule.updateFriendNoteText(params, success, error)
}
/**
* @param {function} success = function (friendArr) {} // 以参数形式返回好友对象数组
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getFriends(success, error) {
JMessageModule.getFriends(success, error)
}
/**
* 创建群组,创建成功后,创建者默认会包含在群成员中。
*
* @param {object} params = {
* 'name': String // 群组名称。
* 'desc': String // 群组描述。
* 'groupType': String // 'public' | 'private'
* }
* @param {function} success = function (groupId) {} // 以参数形式返回 group id
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static createGroup(params, success, error) {
JMessageModule.createGroup(params, success, error)
}
/**
* 获取当前用户所有所在的群组 id。
*
* @param {function} success = function (groupIdArray) {} // 以参数形式返回 group id 数组
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getGroupIds(success, error) {
JMessageModule.getGroupIds(success, error)
}
/**
* @param {object} params = {'id': '群组 id'}
* @param {function} success = function (groupInfo) {} // 以参数形式返回群组信息对象
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getGroupInfo(params, success, error) {
JMessageModule.getGroupInfo(params, success, error)
}
/**
* @param {object} params = {'id': '群组 id', 'newName': '新群组名称', 'newDesc': '新群组介绍'}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static updateGroupInfo(params, success, error) {
JMessageModule.updateGroupInfo(params, success, error)
}
/**
* @param {object} params = {'id': '群组 id', 'usernameArray': [用户名数组], 'appKey': '待添加用户所在应用的 appKey'}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static addGroupMembers(params, success, error) {
JMessageModule.addGroupMembers(params, success, error)
}
/**
* @param {object} params = {'id': '群组 id', 'usernameArray': [用户名数组], 'appKey': '待删除用户所在应用的 appKey'}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static removeGroupMembers(params, success, error) {
JMessageModule.removeGroupMembers(params, success, error)
}
/**
* @param {object} params = {'id': '群组 id'}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static exitGroup(params, success, error) {
JMessageModule.exitGroup(params, success, error)
}
/**
* @param {object} params = {'id': '群组 id'}
* @param {function} success = function (userInfoArray) {} // 以参数形式返回用户对象数组
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getGroupMembers(params, success, error) {
JMessageModule.getGroupMembers(params, success, error)
}
/**
* @param {object} params = {'usernameArray': [用户名数组], 'appKey': '用户所属 AppKey'}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static addUsersToBlacklist(params, success, error) {
JMessageModule.addUsersToBlacklist(params, success, error)
}
/**
* @param {object} params = {'usernameArray': [用户名数组], 'appKey': '用户所属 AppKey'}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static removeUsersFromBlacklist(params, success, error) {
JMessageModule.removeUsersFromBlacklist(params, success, error)
}
/**
* @param {function} success = function (userInfoArray) {} // 以参数形式返回黑名单中的用户信息数组
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getBlacklist(success, error) {
JMessageModule.getBlacklist(success, error)
}
/**
* 设置是否屏蔽群消息。
*
* @param {Object} params = { id: String, isBlock: boolean }
*/
static blockGroupMessage(params, success, error) {
JMessageModule.blockGroupMessage(params, success, error)
}
/**
* 判断指定群组是否被屏蔽。
*
* @param {object} params = { id: String }
* @param {function} success = function ({ isBlocked: boolean }) {} // 以参数形式返回结果。
*/
static isGroupBlocked(params, success, error) {
JMessageModule.isGroupBlocked(params, success, error)
}
/**
* 获取当前用户的群屏蔽列表。
*
* @param {function} success = function (groupArr) {} // 以参数形式返回结果。
*/
static getBlockedGroupList(success, error) {
JMessageModule.getBlockedGroupList(success, error)
}
/**
* 设置某个用户或群组是否免打扰。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'isNoDisturb': Boolean // 是否免打扰。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static setNoDisturb(params, success, error) {
JMessageModule.setNoDisturb(params, success, error)
}
/**
* 获取免打扰用户和群组名单。
*
* @param {function} success = function ({userInfoArray: [], groupInfoArray: []}) {} // 以参数形式返回用户和群组对象数组
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getNoDisturbList(success, error) {
JMessageModule.getNoDisturbList(success, error)
}
/**
* 设置是否全局免打扰。
*
* @param {object} params = {'isNoDisturb': Boolean}
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static setNoDisturbGlobal(params, success, error) {
JMessageModule.setNoDisturbGlobal(params, success, error)
}
/**
* 判断当前是否全局免打扰。
*
* @param {function} success = function ({'isNoDisturb': Boolean}) {} // 以参数形式返回结果
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static isNoDisturbGlobal(success, error) {
JMessageModule.isNoDisturbGlobal(success, error)
}
/**
* 下载用户头像缩略图,如果已经下载,不会重复下载。
*
* @param {object} params = {'username': String, 'appKey': String}
* @param {function} success = function ({'username': String, 'appKey': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadThumbUserAvatar(params, success, error) {
JMessageModule.downloadThumbUserAvatar(params, success, error)
}
/**
* 下载用户头像原图,如果已经下载,不会重复下载。
*
* @param {object} params = {'username': String, 'appKey': String}
* @param {function} success = function ({'username': String, 'appKey': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadOriginalUserAvatar(params, success, error) {
JMessageModule.downloadOriginalUserAvatar(params, success, error)
}
/**
* 下载指定图片消息的缩略图,如果已经下载,会直接返回本地文件路径,不会重复下载。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'messageId': String // 指定消息 id。
* }
* @param {function} success = function ({'messageId': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadOriginalImage(params, success, error) {
JMessageModule.downloadOriginalImage(params, success, error)
}
/**
* 下载指定图片消息的原图,如果已经下载,会直接返回本地文件路径,不会重复下载。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'messageId': String // 指定消息 id。
* }
* @param {function} success = function ({'messageId': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadThumbImage(params, success, error) {
JMessageModule.downloadThumbImage(params, success, error)
}
/**
* 下载语音消息文件,如果已经下载,会直接返回本地文件路径,不会重复下载。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'messageId': String // 指定消息 id。
* }
* @param {function} success = function ({'messageId': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadVoiceFile(params, success, error) {
JMessageModule.downloadVoiceFile(params, success, error)
}
/**
* 下载文件消息文件,如果已经下载,会直接返回本地文件路径,不会重复下载。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'messageId': String // 指定消息 id。
* }
* @param {function} success = function ({'messageId': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadVideoFile(params, success, error) {
JMessageModule.downloadVideoFile(params, success, error)
}
/**
* 下载文件消息文件,如果已经下载,会直接返回本地文件路径,不会重复下载。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'messageId': String // 指定消息 id。
* }
* @param {function} success = function ({'messageId': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadFile(params, success, error) {
JMessageModule.downloadFile(params, success, error)
}
/**
* 创建聊天会话。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group' / 'chatRoom'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'roomId': String, // 聊天室 id.
* }
* @param {function} success = function (conversation) {} // 以参数形式返回聊天会话对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static createConversation(params, success, error) {
JMessageModule.createConversation(params, success, error)
}
/**
* 删除聊天会话,同时会删除本地聊天记录。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group' / 'chatRoom'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* 'roomId': String, // 聊天室 id.
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static deleteConversation(params, success, error) {
JMessageModule.deleteConversation(params, success, error)
}
/**
* Android Only
* 进入聊天会话。可以在进入聊天会话页面时调用该方法,这样在收到当前聊天用户的消息时,不会显示通知。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static enterConversation(params, success, error) {
if (Platform.OS === 'android') {
JMessageModule.enterConversation(params, success, error)
}
}
/**
* Android Only
* 退出会话,和 enterConversation 方法成对使用
*/
static exitConversation() {
if (Platform.OS === 'android') {
JMessageModule.exitConversation()
}
}
/**
* iOS Only
* 设置服务器 badge 值,用于 badge+1 功能
* 成功返回 true
*/
static setBadge (badge, cb) {
if (Platform.OS === 'ios') {
JMessageModule.setBadge(badge, value => {
cb(value)
})
}
}
/**
* @param {object} params = {
* 'type': String, // 'single' / 'group' / 'chatRoom'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'roomId': String, // 聊天室 id.
* 'appKey': String, // 目标用户所属 AppKey。
* }
* @param {function} success = function (conversation) {} // 以参数形式返回聊天会话对象。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getConversation(params, success, error) {
JMessageModule.getConversation(params, success, error)
}
/**
* @param {function} success = function (conversationArray) {} // 以参数形式返回会话对象数组。
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static getConversations(success, error) {
JMessageModule.getConversations(success, error)
}
/**
* 重置单个会话的未读消息数。
*
* @param {object} params = {
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* }
* @param {function} success = function () {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static resetUnreadMessageCount(params, success, error) {
JMessageModule.resetUnreadMessageCount(params, success, error)
}
/**
* 更新当前用户头像。
*
* @param {object} params = {
* id: string // 目标群组的 id。
* imgPath: string // 本地图片绝对路径。
* }
* 注意 Android 与 iOS 的文件路径是不同的:
* - Android 类似:/storage/emulated/0/DCIM/Camera/IMG_20160526_130223.jpg
* - iOS 类似:/var/mobile/Containers/Data/Application/7DC5CDFF-6581-4AD3-B165-B604EBAB1250/tmp/photo.jpg
*/
static updateGroupAvatar(params, success, error) {
JMessageModule.updateGroupAvatar(params, success, error)
}
/**
* 下载群组头像缩略图,如果已经下载,不会重复下载。
*
* @param {object} params = {'id': String}
* @param {function} success = function ({'id': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadThumbGroupAvatar(params, success, error) {
JMessageModule.downloadThumbGroupAvatar(params, success, error)
}
/**
* 下载群组头像原图,如果已经下载,不会重复下载。
*
* @param {object} params = {'id': String}
* @param {function} success = function ({'id': String, 'filePath': String}) {}
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static downloadOriginalGroupAvatar(params, success, error) {
JMessageModule.downloadOriginalGroupAvatar(params, success, error)
}
/**
* 增加或更新扩展字段,可扩展会话属性,比如:会话置顶、标识特殊会话等
*
* @param {object} params = {
* 'extras': Object // 附加字段对象
* 'type': String, // 'single' / 'group'
* 'groupId': String, // 目标群组 id。
* 'username': String, // 目标用户名。
* 'appKey': String, // 目标用户所属 AppKey。
* }
* @param {function} success = function (conversation) {} // 具体字段参考文档
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static setConversationExtras(params, success, error) {
JMessageModule.setConversationExtras(params, success, error)
}
/**
* 设置消息已读
* @param {object} params = {
* 必填,不可为空
* ‘type’: String single/group/chatroom
*
* type为single时,除了下面的其他值可缺省
* 'username': String
* 'appKey': String
* 'id': String
*
* type为group时,除了下面的其他值可缺省
* 'groupId': String
*
* type为chatroom时,除了下面的其他值可缺省
* 'roomId': String
*
* 必填,不可为空
* 'id': String
*
* }
* @param {function} successCallback = function () {}
* @param {function} failCallback = function ({'code': '错误码', 'description': '错误信息'}) {}
*/
static setMsgHaveRead(params,successCallback,failCallback){
JMessageModule.setMsgHaveRead(params,successCallback,failCallback)
}
/**
*
* JMessage Events
*
*/
/**
* 添加收到消息事件监听。
*
* @param {function} listener = function (message) {} // 以参数形式返回消息对象。
* message = {
* 'id': String,
* 'from': object, // 消息发送者信息对象。
* 'target': object, // 消息接收方信息(可能为用户或者群组)。
* 'type': String // 'text' / 'image' / 'voice' / 'location' / 'file' / 'custom' / 'event'
* ... // 不同消息类型还有其他对应的相关字段,具体可参考文档。
* }
*/
static addReceiveMessageListener(listener) {
listeners[listener] = DeviceEventEmitter.addListener(receiveMsgEvent,
(message) => {