Skip to content

Commit 6ec29f6

Browse files
OnYourMark-1995OnYourMark-1995
authored
fix: improve parameter consistency and clarity across APIs (#78)
1 parent be83eab commit 6ec29f6

5 files changed

Lines changed: 99 additions & 103 deletions

File tree

‎android/src/main/java/com/openimsdkrn/OpenImSdkRnModule.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -798,12 +798,12 @@ public void deleteFriend(String friendUserID, String operationID, Promise promis
798798
}
799799

800800
@ReactMethod
801-
public void getFriendApplicationListAsRecipient(String operationID, ReadableMap req, Promise promise) {
801+
public void getFriendApplicationListAsRecipient(ReadableMap req, String operationID, Promise promise) {
802802
Open_im_sdk.getFriendApplicationListAsRecipient(new BaseImpl(promise), operationID, map2string(req));
803803
}
804804

805805
@ReactMethod
806-
public void getFriendApplicationListAsApplicant(String operationID, ReadableMap req, Promise promise) {
806+
public void getFriendApplicationListAsApplicant(ReadableMap req, String operationID, Promise promise) {
807807
Open_im_sdk.getFriendApplicationListAsApplicant(new BaseImpl(promise), operationID, map2string(req));
808808
}
809809

@@ -985,12 +985,12 @@ public void inviteUserToGroup(ReadableMap options, String operationID, Promise p
985985
}
986986

987987
@ReactMethod
988-
public void getGroupApplicationListAsRecipient(String operationID, ReadableMap req, Promise promise) {
988+
public void getGroupApplicationListAsRecipient(ReadableMap req, String operationID, Promise promise) {
989989
Open_im_sdk.getGroupApplicationListAsRecipient(new BaseImpl(promise), operationID, map2string(req));
990990
}
991991

992992
@ReactMethod
993-
public void getGroupApplicationListAsApplicant(String operationID, ReadableMap req, Promise promise) {
993+
public void getGroupApplicationListAsApplicant(ReadableMap req, String operationID, Promise promise) {
994994
Open_im_sdk.getGroupApplicationListAsApplicant(new BaseImpl(promise), operationID, map2string(req));
995995
}
996996

‎ios/OpenImSdkRn.m‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -900,12 +900,12 @@ - (NSArray *)parseJsonStr2Array:(NSString *)jsonStr {
900900
Open_im_sdkDeleteFriend(proxy, operationID, friendUserID);
901901
}
902902

903-
RCT_EXPORT_METHOD(getFriendApplicationListAsRecipient:(NSString *)operationID req: (NSDictionary *)req resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
903+
RCT_EXPORT_METHOD(getFriendApplicationListAsRecipient:(NSDictionary *)req operationID:(NSString *)operationID resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
904904
RNCallbackProxy *proxy = [[RNCallbackProxy alloc] initWithCallback:resolver rejecter:rejecter];
905905
Open_im_sdkGetFriendApplicationListAsRecipient(proxy, operationID, [req json]);
906906
}
907907

908-
RCT_EXPORT_METHOD(getFriendApplicationListAsApplicant:(NSString *)operationID req: (NSDictionary *)req resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
908+
RCT_EXPORT_METHOD(getFriendApplicationListAsApplicant:(NSDictionary *)req operationID:(NSString *)operationID resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
909909
RNCallbackProxy *proxy = [[RNCallbackProxy alloc] initWithCallback:resolver rejecter:rejecter];
910910
Open_im_sdkGetFriendApplicationListAsApplicant(proxy, operationID, [req json]);
911911
}
@@ -1151,12 +1151,12 @@ - (NSArray *)parseJsonStr2Array:(NSString *)jsonStr {
11511151
Open_im_sdkInviteUserToGroup(proxy, operationID, groupID, reason, [userIDList json]);
11521152
}
11531153

1154-
RCT_EXPORT_METHOD(getGroupApplicationListAsRecipient:(NSString *)operationID req: (NSDictionary *)req resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
1154+
RCT_EXPORT_METHOD(getGroupApplicationListAsRecipient:(NSDictionary *)req operationID:(NSString *)operationID resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
11551155
RNCallbackProxy *proxy = [[RNCallbackProxy alloc] initWithCallback:resolver rejecter:rejecter];
11561156
Open_im_sdkGetGroupApplicationListAsRecipient(proxy, operationID, [req json]);
11571157
}
11581158

1159-
RCT_EXPORT_METHOD(getGroupApplicationListAsApplicant:(NSString *)operationID req: (NSDictionary *)req resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
1159+
RCT_EXPORT_METHOD(getGroupApplicationListAsApplicant:(NSDictionary *)req operationID:(NSString *)operationID resolver:(RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter) {
11601160
RNCallbackProxy *proxy = [[RNCallbackProxy alloc] initWithCallback:resolver rejecter:rejecter];
11611161
Open_im_sdkGetGroupApplicationListAsApplicant(proxy, operationID, [req json]);
11621162
}

‎src/OpenIMSDK.native.ts‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ import {
5555
LogsParams,
5656
MergerMsgParams,
5757
OffsetParams,
58-
OpreateGroupParams,
59-
OpreateMessageParams,
58+
OperateGroupParams,
59+
OperateMessageParams,
6060
PinConversationParams,
6161
QuoteMsgParams,
6262
RemarkFriendParams,
@@ -70,7 +70,7 @@ import {
7070
SetConversationParams,
7171
SetConversationPrivateParams,
7272
SetConversationRecvOptParams,
73-
SetGroupinfoParams,
73+
SetGroupInfoParams,
7474
SetMessageLocalExParams,
7575
SoundMsgByPathParams,
7676
SoundMsgParams,
@@ -134,16 +134,16 @@ export interface NativeOpenIMSDKInterface {
134134
operationID: string
135135
) => Promise<unknown>;
136136
subscribeUsersStatus: (
137-
params: string[],
137+
userIDs: string[],
138138
operationID: string
139139
) => Promise<UserOnlineState[]>;
140140
unsubscribeUsersStatus: (
141-
params: string[],
141+
userIDs: string[],
142142
operationID: string
143143
) => Promise<unknown>;
144144
getSubscribeUsersStatus: (operationID: string) => Promise<UserOnlineState[]>;
145145
setAppBackgroundStatus: (
146-
params: boolean,
146+
isBackground: boolean,
147147
operationID: string
148148
) => Promise<unknown>;
149149
networkStatusChanged: (operationID: string) => Promise<unknown>;
@@ -163,18 +163,18 @@ export interface NativeOpenIMSDKInterface {
163163
addBlack: (params: AddBlackParams, operationID: string) => Promise<unknown>;
164164
addFriend: (params: AddFriendParams, operationID: string) => Promise<unknown>;
165165
checkFriend: (
166-
params: string[],
166+
friendUserIDList: string[],
167167
operationID: string
168168
) => Promise<FriendshipInfo[]>;
169-
deleteFriend: (params: string, operationID: string) => Promise<unknown>;
169+
deleteFriend: (friendUserID: string, operationID: string) => Promise<unknown>;
170170
getBlackList: (operationID: string) => Promise<BlackUserItem[]>;
171171
getFriendApplicationListAsApplicant: (
172-
operationID: string,
173-
req: GetFriendApplicationListAsApplicantParams
172+
req: GetFriendApplicationListAsApplicantParams,
173+
operationID: string
174174
) => Promise<FriendApplicationItem[]>;
175175
getFriendApplicationListAsRecipient: (
176-
operationID: string,
177-
req: GetFriendApplicationListAsRecipientParams
176+
req: GetFriendApplicationListAsRecipientParams,
177+
operationID: string
178178
) => Promise<FriendApplicationItem[]>;
179179
getFriendApplicationUnhandledCount: (
180180
req: GetSelfApplicationUnhandledCountParams,
@@ -200,7 +200,7 @@ export interface NativeOpenIMSDKInterface {
200200
params: AccessFriendParams,
201201
operationID: string
202202
) => Promise<unknown>;
203-
removeBlack: (params: string, operationID: string) => Promise<unknown>;
203+
removeBlack: (blackUserID: string, operationID: string) => Promise<unknown>;
204204
searchFriends: (
205205
params: SearchFriendParams,
206206
operationID: string
@@ -217,7 +217,7 @@ export interface NativeOpenIMSDKInterface {
217217
) => Promise<GroupItem>;
218218
joinGroup: (params: JoinGroupParams, operationID: string) => Promise<unknown>;
219219
inviteUserToGroup: (
220-
params: OpreateGroupParams,
220+
params: OperateGroupParams,
221221
operationID: string
222222
) => Promise<unknown>;
223223
getJoinedGroupList: (operationID: string) => Promise<GroupItem[]>;
@@ -230,20 +230,20 @@ export interface NativeOpenIMSDKInterface {
230230
operationID: string
231231
) => Promise<GroupItem[]>;
232232
getSpecifiedGroupsInfo: (
233-
params: string[],
233+
groupIDs: string[],
234234
operationID: string
235235
) => Promise<GroupItem[]>;
236236
setGroupInfo: (
237-
params: SetGroupinfoParams,
237+
params: SetGroupInfoParams,
238238
operationID: string
239239
) => Promise<unknown>;
240240
getGroupApplicationListAsRecipient: (
241-
operationID: string,
242-
req: GetGroupApplicationListAsRecipientParams
241+
req: GetGroupApplicationListAsRecipientParams,
242+
operationID: string
243243
) => Promise<GroupApplicationItem[]>;
244244
getGroupApplicationListAsApplicant: (
245-
operationID: string,
246-
req: GetGroupApplicationListAsApplicantParams
245+
req: GetGroupApplicationListAsApplicantParams,
246+
operationID: string
247247
) => Promise<GroupApplicationItem[]>;
248248
getGroupApplicationUnhandledCount: (
249249
req: GetSelfApplicationUnhandledCountParams,
@@ -278,15 +278,15 @@ export interface NativeOpenIMSDKInterface {
278278
operationID: string
279279
) => Promise<unknown>;
280280
getGroupMemberOwnerAndAdmin: (
281-
params: string,
281+
groupID: string,
282282
operationID: string
283283
) => Promise<GroupMemberItem[]>;
284284
getGroupMemberListByJoinTimeFilter: (
285285
params: GetGroupMemberByTimeParams,
286286
operationID: string
287287
) => Promise<GroupMemberItem[]>;
288288
kickGroupMember: (
289-
params: OpreateGroupParams,
289+
params: OperateGroupParams,
290290
operationID: string
291291
) => Promise<unknown>;
292292
changeGroupMemberMute: (
@@ -301,8 +301,8 @@ export interface NativeOpenIMSDKInterface {
301301
params: TransferGroupParams,
302302
operationID: string
303303
) => Promise<unknown>;
304-
dismissGroup: (params: string, operationID: string) => Promise<unknown>;
305-
quitGroup: (params: string, operationID: string) => Promise<unknown>;
304+
dismissGroup: (groupID: string, operationID: string) => Promise<unknown>;
305+
quitGroup: (groupID: string, operationID: string) => Promise<unknown>;
306306
isJoinGroup: (groupID: string, operationID: string) => Promise<boolean>;
307307

308308
// conversation & message
@@ -316,7 +316,7 @@ export interface NativeOpenIMSDKInterface {
316316
operationID: string
317317
) => Promise<ConversationItem>;
318318
getMultipleConversation: (
319-
params: string,
319+
conversationIDList: string[],
320320
operationID: string
321321
) => Promise<ConversationItem[]>;
322322
getConversationIDBySessionType: (
@@ -325,7 +325,7 @@ export interface NativeOpenIMSDKInterface {
325325
) => Promise<ConversationItem>;
326326
getTotalUnreadMsgCount: (operationID: string) => Promise<number>;
327327
markConversationMessageAsRead: (
328-
params: string,
328+
conversationID: string,
329329
operationID: string
330330
) => Promise<unknown>;
331331
setConversation: (
@@ -353,22 +353,22 @@ export interface NativeOpenIMSDKInterface {
353353
operationID: string
354354
) => Promise<unknown>;
355355
resetConversationGroupAtType: (
356-
params: string,
356+
conversationID: string,
357357
operationID: string
358358
) => Promise<unknown>;
359-
hideConversation: (params: string, operationID: string) => Promise<unknown>;
359+
hideConversation: (conversationID: string, operationID: string) => Promise<unknown>;
360360
hideAllConversation: (operationID: string) => Promise<unknown>;
361361
clearConversationAndDeleteAllMsg: (
362-
params: string,
362+
conversationID: string,
363363
operationID: string
364364
) => Promise<unknown>;
365365
deleteConversationAndDeleteAllMsg: (
366-
params: string,
366+
conversationID: string,
367367
operationID: string
368368
) => Promise<unknown>;
369369

370370
createImageMessageFromFullPath: (
371-
params: string,
371+
imagePath: string,
372372
operationID: string
373373
) => Promise<MessageItem>;
374374
createVideoMessageFromFullPath: (
@@ -384,7 +384,7 @@ export interface NativeOpenIMSDKInterface {
384384
operationID: string
385385
) => Promise<MessageItem>;
386386
createTextMessage: (
387-
params: string,
387+
text: string,
388388
operationID: string
389389
) => Promise<MessageItem>;
390390
createTextAtMessage: (
@@ -456,15 +456,15 @@ export interface NativeOpenIMSDKInterface {
456456
operationID: string
457457
) => Promise<number[]>;
458458
revokeMessage: (
459-
params: OpreateMessageParams,
459+
params: OperateMessageParams,
460460
operationID: string
461461
) => Promise<unknown>;
462462
deleteMessage: (
463-
params: OpreateMessageParams,
463+
params: OperateMessageParams,
464464
operationID: string
465465
) => Promise<unknown>;
466466
deleteMessageFromLocalStorage: (
467-
params: OpreateMessageParams,
467+
params: OperateMessageParams,
468468
operationID: string
469469
) => Promise<unknown>;
470470
deleteAllMsgFromLocal: (operationID: string) => Promise<unknown>;

0 commit comments

Comments
 (0)