GizAepWifiSDK 类

机智云 AEP SDK 的基础类，为APP开发者提供用户、日志、图片上传相关方法

目录

API 定义

[sharedInstance]

获取 GizAepWifiSDK 单例的实例。 返回值返回初始化后 AEP SDK 唯一的实例。SDK 未初始化，或者初始化失败，返回 nil。

定义

+ (instancetype)sharedInstance;

代码示例

GizAepWifiSDK *instance = [GizAepWifiSDK sharedInstance];

[getVersion]

获取 AEP SDK 版本号

定义

+ (NSString* _Nonnull)getVersion;

代码示例

NSString *version = [GizAepWifiSDK getVersion];

[sendCode]

发送验证码

定义

- (void)sendCode:(NSString * _Nonnull)account language:(GizLanguageType)language callback:(void (^ _Nullable)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
account 只支持手机或者邮箱格式
language 短信或者邮件的语言参数，传值-1，自动按手机语言处理
callback 发送验证码结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepWifiSDK sharedInstance] sendCode:@"your_phone_number" language:-1 callback:^(AepApiResult * _Nonnull result) {

}];

[login]

根据验证码登录

定义

- (void)login:(NSString * _Nonnull)account code:(NSString * _Nonnull)code homeName:(NSString* _Nullable)homeName language:(GizLanguageType)language callback:(void (^ _Nullable)(AepLoginResult * _Nonnull result))callback;

参数

属性名 描述
account 只支持手机或者邮箱格式
code 通过“获取验证码”接口获取到验证码
homeName 选填，默认初始化家庭名称，只有新用户未有家庭的时候才使用，默认值（中文环境：我的家，其他语言环境：My home）
language 用户初始化语言，传值-1，自动按手机语言处理
callback 登录结果回调

回调参数

属性名 描述
result 详细见 AepLoginResult 定义

代码示例

[[GizAepWifiSDK sharedInstance] login:"your_phone_number" code:@"your_code" homeName:nil language:-1  callback:^(AepLoginResult * _Nonnull result) {
}];

[loginToken]

极光认证一键登录

定义

- (void)loginToken:(NSString * _Nonnull)loginToken homeName:(NSString* _Nullable)homeName language:(GizLanguageType)language callback:(void (^_Nullable)(AepLoginResult* _Nonnull result))callback;

参数

属性名 描述
loginToken 极光认证获取的手机号校验token
homeName 选填，默认初始化家庭名称，只有新用户未有家庭的时候才使用，默认值（中文环境：我的家，其他语言环境：My home）
language 用户初始化语言，传值-1，自动按手机语言处理
callback 登录结果回调

回调参数

属性名 描述
result 详细见 AepLoginResult 定义

代码示例

[[GizAepWifiSDK sharedInstance] loginToken:@"your_loginToken" homeName:@"your_homeName" language:-1 callback:^(int * _Nonnull result) {

}];

[thirdLogin]

第三方登录

定义

- (void)thirdLogin:(GizThirdLoginParams* _Nonnull)loginParams homeName:(NSString* _Nonnull)homeName language:(GizLanguageType)language callback:(void (^ _Nullable)(AepLoginResult* _Nonnull result))callback;

参数

属性名 描述
loginParams 第三方登录参数
homeName 默认初始化家庭名称，选填，只有新用户未有家庭的时候才使用，默认值（中文环境：我的家，其他语言环境：My
language 用户初始化语言，传值-1，自动按手机语言处理
callback 登录结果，可获取信息查看AepLoginResult类属性

回调参数

属性名 描述
result 详细见 AepLoginResult 定义

代码示例

NSLog(@"Hello world!");

[getUserInformation]

获取用户信息

定义

- (void)getUserInformation:(void (^_Nullable)(AepApiResult* _Nullable result,GizAepApiUser* _Nullable userInfo))callback;

参数

属性名 描述
callback 获取信息结果，可获取信息查看AepApiResult，GizAepApiUser类属性

回调参数

属性名 描述
result 详细见 AepApiResult 定义
userInfo 用户信息对象，详细见GizAepApiUser类

代码示例

// 先登录再调用此接口
[[GizAepWifiSDK sharedInstance] getUserInformation:^(AepApiResult * _Nonnull result, GizAepApiUser * _Nonnull userInfo) {
}];

[updateUserInfo]

修改用户信息

定义

- (void)updateUserInfo:(NSDictionary* _Nonnull)info language:(GizLanguageType)language callback:(void (^_Nullable)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
info 参数，必填，支持以下参数，未填写字段会把值置空
language 用户语言
callback 修改结果，可获取信息查看AepApiResult类属性

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

NSDictionary* params = @{@"address": @"your_address",@"avatar":@"your_avatar",@"gender":@(GizUserGenderMale),@"nickname":@"your_nickname"};
[[GizAepWifiSDK sharedInstance] updateUserInfo:params language:GIZ_LANGUAGE_ZH callback:^(AepApiResult * _Nonnull result) {
 }];

[updateAccount]

更改用户登录账号

定义

- (void)updateAccount:(NSString* _Nonnull)account code:(NSString* _Nonnull)code callback:(void (^_Nonnull)(AepApiResult* _Nullable result))callback;

参数

属性名 描述
account 只支持手机或者邮箱格式
code 通过“获取验证码”接口获取到验证码
callback 修改结果，可获取信息查看AepApiResult类属性

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

// 登录账号方可调用
[[GizAepWifiSDK sharedInstance] updateAccount:@"your_email" code:@"your_email_code" callback:^(AepApiResult * _Nonnull result) {
}];

[refreshToken]

刷新token

定义

- (void)refreshToken:(NSString* _Nonnull)refreshToken callback:(void (^_Nullable)(AepLoginResult* _Nonnull result))callback;

参数

属性名 描述
refreshToken 通过登录接口获取到的refreshToken
callback 刷新结果，可获取信息查看AepLoginResult类属性

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepWifiSDK sharedInstance] refreshToken:@"your_refreshToken" callback:^(AepApiResult * _Nonnull result) {
}];

[destructionAccountByCode]

注销账号

定义

- (void)destructionAccountByCode:(NSString* _Nonnull)code type:(NSInteger)type callback:(void (^_Nullable)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
code 使用用户的邮箱或手机，通过“获取验证码”接口获取到验证码
type 验证类型，手机传1，邮箱传2
callback 请求结果，可获取信息查看AepApiResult

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepWifiSDK sharedInstance] destructionAccountByCode:@"your_email_code" type:2 callback:^(AepApiResult * _Nonnull result) {
}];

[userFeedback]

意见反馈接口

定义

- (void)userFeedback:(NSString * _Nullable)content phone:(NSString * _Nullable)phone pictureUrl:(NSString * _Nullable)pictureUrl callback:(void (^ _Nullable)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
content 反馈内容
phone 手机号码
pictureUrl 图片地址，多个图片使用分号(;)隔开
callback 请求结果，可获取信息查看AepApiResult，GizAepApiHome

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

// 若有错误截图等，可通过《uploadImageData》上传图片，把图片url传给userFeedback
NSString *url = @"http://baidu.com"; 
[[GizAepWifiSDK sharedInstance] userFeedback:@"your_wrong" phone:@"your_phone_number" pictureUrl:url callback:^(AepApiResult * _Nonnull result) {
}];

[uploadImageData]

图片上传接口

定义

- (void)uploadImageData:(NSData * _Nonnull)data fileName:(NSString * _Nonnull)fileName imageType:(GizImageType)imageType callback:(void (^ _Nullable)(AepApiResult * _Nonnull result,NSString * _Nullable url ))callback;

参数

属性名 描述
data 图片的二进制文件
fileName 文件名
imageType 图片类型，见枚举GizImageType
callback 请求结果

回调参数

属性名 描述
result 详细见 AepApiResult 定义
url 上传图片的url地址

代码示例

[[GizAepWifiSDK sharedInstance] uploadImageData:@"your_Image_data" fileName:@"your_Image_name" imageType:GizImagePng callback:^(AepApiResult * _Nonnull result,NSString * _Nonnull url) {
}];

results matching ""

    No results matching ""