AccountAPI class

Constructors

AccountAPI()

Properties

deviceStateStream Stream<DeviceState>
no setter
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

checkResetPwdIsActivated({required String userId}) Future<int>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
xcAccountBindPhoneOrEmail({required String phoneOrEmail, required String verCode}) Future<bool>
账户绑定手机号或者邮箱 phoneOrEmail手机号或者邮箱 verCode 验证码
xcAccountCancellationGetPhoneOrMailVerifyCode() Future<bool>
账号注销-获取验证码
xcAccountCancellationWithCode({required String verCode}) Future<bool>
账号注销-验证码注销 szVerCode验证码 return code:0 注意: 此接口由于兼容考虑,需要调用一次或两次 当账号没有绑定邮箱或手机号时,验证码传空,调用一次此接口即可注销账号,会收到id为5075的回调,表示注销账号成功; 当账号已绑定邮箱或手机号时,需要调用两次:第一次调用时验证码传空,会收到id为-604302的回调,表示“验证码发送成功”;第二次调用时,传入验证码,会收到id为5075的回调,表示注销账号成功。
xcAccountCancellationWithoutCode() Future<bool>
账号注销-不需要验证码-直接注销
xcAddDevice({required DevAdd devAdd}) Future<int>
添加设备 v0 deviceJson 添加设备json return data:设备信息(Json格式)
xcAddDeviceV1({required String requestJs}) Future<int>
添加设备v1
xcCheckUserIsActivated({required String userId}) Future<bool>
检查用户是否激活.是否点击了邮箱注册链接 userId 用户id return code>=0 true or false
xcDecodeInfo({String encodeStr = ''}) Future<String>
解码信息 decodeStr 待解码字符 xcEncodeInfo接口返回的key return code:0 data:json数据 回调码 5204
xcEditDeviceInfo({required String deviceId, String? userName, String? nickName, String? port}) Future<bool>
编辑设备信息 仅编辑服务器上存储的设备信息的 可以编辑
xcEmailRegister({required String email, required String password}) Future<String>
邮箱注册发送验证码 email邮箱 password 密码 return userId
xcEncodeInfo({required String encodeStr, int expireTime = 1800000}) Future<Map<String, dynamic>>
编码信息 encodeStr 待编码字符 expireTime 过期时间,默认30min,单位毫秒 return code:0 data:json数据 回调码 5203
xcForgetPwdToGetCode({required String phoneOrEmail, String serverName = 'customer'}) Future<bool>
忘记密码-获取验证码(发验证码) phoneOrEmail手机号或者邮箱 serverName服务商名称 return code:0 data:json用户信息 回调码 5043 EACT_MSG_SEND_EMAIL_FOR_CODE 传入参数为邮箱时 回调码 5014 EACT_MSG_FORGET_PWD_XM 传入参数为手机号时
xcForgetPwdToResetPwd({required String phoneOrEmail, required String newPassword, required String verCode}) Future<bool>
忘记密码-重置密码 phoneOrEmail手机号或者邮箱 newPassword新密码 verCode验证码 return code:0 data:json用户信息 回调码 5045 传入参数为邮箱时 回调码 5016 传入参数为手机号时
xcForgetPwdToResetPwdBySendEmail({required String email}) Future<String>
发送链接邮件用于重置密码 email 邮箱 注意忘记密码手机号只支持验证码,邮箱支持xcForgetPwdToResetPwd(验证码)也支持当前方式(邮件)找回
xcGetAccessToken() Future<String>
登录之后-获取登录token--
xcGetAreaCode() Future<List<Map<String, dynamic>>>
获取app支持的区号 return code:0 data:json用户信息 回调码 5081
xcGetDevicesState({required List<String> uuids}) → void
xcGetDevState({required String deviceId}) Future<int>
获取设备状态 deviceId 设备序列号 or ip+port return code:0
xcGetGlobalPhoneCode<T>({required String phoneNumber, required String type}) Future<bool>
获取手机验证码-国外(除中国之外)手机号获取验证码 phoneNumber手机号 type 发送验证码功能类型 re:注册 fp:找回密码 login:登陆 bin:绑定 ucan:注销 返回值 { code: >=0成功,否则失败 message: 返回的type,就是传的参数szType,用来区分哪种类型返回的结果; data: 找回密码的时候返回当前手机号绑定的用户名,其他类型不返回; } 回调码 5082
xcGetPhoneSupportAreaCodeAndUrl() Future<Map<String, dynamic>>
获取支持手机验证的全球区号和区域URL
xcGetRealAccessToken() Future<String>
登录之后-获取登录token
xcGetUserInfo() Future<Map<String, dynamic>>
获取用户信息接口 return map 用户信息
xcGetVerCodeForBindAccount({required String phoneOrEmail, String userName = "Customer"}) Future<bool>
账户绑定手机号或者邮箱验证码获取 phoneOrEmail手机号或者邮箱 userName 默认Custom,邮箱抬头称呼
xcLoginAndGetDeviceList({required String userName, required String pwd}) Future<Map<String, dynamic>>
登录账号并获取设备列表 userName 用户名 pwd密码 return Map
xcLoginOut() Future
退出登录
xcModifyAccountNickName({required String nickname}) Future<bool>
修改用户昵称
xcQueryDeviceList() Future<Map<String, dynamic>>
查询设备列表
xcRegisterToCheckCode({required String phoneOrMail, required String verCode}) Future<bool>
注册-验证手机验证码 phoneOrMail手机号或邮箱地址 verCode验证码 返回值 { code: >=0成功,否则失败 } 回调码 5100
xcRegisterToGetChinaPhoneCode({required String phoneNumber}) Future<bool>
手机号注册-国内手机号获取验证码 phoneNumber手机号 return code:0 回调码 5010
xcRegisterWithPhone({required PhoneRegisterModel model, required String verCode}) Future<bool>
手机号注册 model用户信息 :Json格式 verCode 验证码 ApiSeq.instance.getSeq() 自定义值 return code:0 回调码 5011
xcRemoveDevice(String deviceId) Future<bool>
删除设备 deviceId 设备序列号 or ip+port return 是否删除成功
xcResetAccountPwd({required String newPassword}) Future<bool>
账号重置密码 newPassword新密码 return code:0 回调码 5013
xcResetPasswordToCheckCode({required String phoneOrMail, required String verCode}) Future<bool>
校验验证码,重置密码时使用 phoneOrMail手机号或邮箱地址 verCode验证码 返回值 { code: >=0成功,否则失败 }
xcSmsLoginAndGetDevList({required String phone, required String verCode}) Future<Map<String, dynamic>>
手机号登录
xcSmsLoginToGetCode({required String phone}) Future<bool>
手机号登录获取验证码

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

instance AccountAPI
no setter