更换项目

YuMi/Structure/MVP/Api/Api.h

@@ -6,42 +6,82 @@
 //
 
 #import <Foundation/Foundation.h>
-#import "HttpRequestFacilitater.h"
+#import "HttpRequestHelper.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface Api : NSObject
 
-
-+ (void)manufactureDemand:(NSString *)route method:(HttpRequestHelperMethod)method completion:(HttpRequestHelperCompletion)completion, ...;
+/**
+ route : 接口路径
+ method : http 请求方法（POST、GET等）
+ completion : 网络请求完成的回调
+ ... : 可变参数，第一个为 __FUNCTION__ ，接下来依次为该接口的协议参数
+ */
++ (void)makeRequest:(NSString *)route method:(HttpRequestHelperMethod)method completion:(HttpRequestHelperCompletion)completion, ...;
 
 + (void)getUserInfo:(HttpRequestHelperCompletion)completion uid:(NSString *)uid;
-+ (void)acquireConsumerAbstracts:(HttpRequestHelperCompletion)completion uids:(NSString *)uids;
+///获取多个用户的信息
++ (void)getUserInfos:(HttpRequestHelperCompletion)completion uids:(NSString *)uids;
 
-+ (void)mobileSmsCryptogram:(HttpRequestHelperCompletion)completion mobile:(NSString *)mobile type:(NSString *)type phoneAreaCode:(NSString *)phoneAreaCode;
+/// 获取手机号的验证码
+/// @param completion 请求完成
+/// @param mobile 手机号
+/// @param type 类型 请看XPEunm中的枚举
++ (void)phoneSmsCode:(HttpRequestHelperCompletion)completion mobile:(NSString *)mobile type:(NSString *)type phoneAreaCode:(NSString *)phoneAreaCode;
 
-+ (void)examineAplictowardsionartowardsusCryptogram:(HttpRequestHelperCompletion)complection
+/// 校验手机号码
+/// @param complection 完成
+/// @param mobile 手机号
+/// @param code 验证码
+/// @param uid 用户的uid
+/// @param ticket ticket
++ (void)checkMoblieCode:(HttpRequestHelperCompletion)complection
 								mobile:(NSString *)mobile
 								  code:(NSString *)code
 								   uid:(NSString *)uid
 								ticket:(NSString *)ticket;
 
-+ (void)accomplishConsumerAbstract:(HttpRequestHelperCompletion)complection
+/// 补全用户资料
+/// @param complection 完成
+/// @param userInfo  需要更新的用户信息
++ (void)completeUserInfo:(HttpRequestHelperCompletion)complection
 							 userInfo:(NSDictionary *)userInfo;
-+ (void)acquireConsumerPocketbookAbstract:(HttpRequestHelperCompletion)complection
+/// 获取用户钱包余额信息
+/// @param complection 完成
+/// @param uid 用户uid
+/// @param ticket ticketg
++ (void)getUserWalletInfo:(HttpRequestHelperCompletion)complection
 										uid:(NSString *)uid
 									 ticket:(NSString *)ticket;
-+ (void)requisitionCheckSplconcludeidIdents:(HttpRequestHelperCompletion)complection
+///  批量验证
+/// @param complection 完成
+/// @param transcationIdStr 需要验证的数据
++ (void)requestCheckTranscationIds:(HttpRequestHelperCompletion)complection
 								 transcationIdStr:(NSString *)transcationIdStr;
 
-+ (void)miecreoscoopeBretowardshaedImplementtowardsion:(HttpRequestHelperCompletion)complection
+/// 锁麦/开麦
+/// @param complection 完成
+/// @param roomUid 房主的uid
+/// @param state 0 开麦 1 锁麦
+/// @param position 坑位
+/// @param ticket 用户的ticket
+/// @param uid uid
++ (void)microMuteCompletion:(HttpRequestHelperCompletion)complection
 					roomUid:(NSString *)roomUid
 					  state:(NSString *)state
 				   position:(NSString *)position
 					 ticket:(NSString *)ticket
 						uid:(NSString *)uid;
 
-+ (void)miecreoscoopeSpokeImplementtowardsion:(HttpRequestHelperCompletion)complection
+/// 锁坑/开锁
+/// @param complection 完成
+/// @param roomUid 房主的uid
+/// @param state 1锁坑位，0取消锁（即取消锁坑位）
+/// @param position 坑位
+/// @param ticket 用户的ticket
+/// @param uid uid
++ (void)microLockCompletion:(HttpRequestHelperCompletion)complection
 					roomUid:(NSString *)roomUid
 					  state:(NSString *)state
 				   position:(NSString *)position