ApiCm005 class
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
Static Methods
-
addCopyProgramToSelf(String copyProgramId, String userId, String deviceId)
→ Future<String>
-
-
addFeedback(String userId, String content, String contactDetail, List<File>? files)
→ Future<String>
-
新增意见反馈
userId 用户id
content 反馈内容
contactDetail 联系方式
files 图片文件数组 可空
-
addProgram(String programInfoJsonStr)
→ Future<String>
-
新增工作程序
programInfoJsonStr 新增工作程序请求对象的json字符串
-
bindDevice(String userId, String barcode, {String? barcodeType})
→ Future<String>
-
APP扫码绑定设备
userId app用户id
barcode 二维码内容
barcodeType 1或者不传表示扫码绑定设备；2表示输入设备码（即序列号）绑定设备
-
bindPhoneCaptchaWechat(String phone)
→ Future<String>
-
微信用户绑定手机号发送验证码
phone 手机号
-
bindPhoneWechat(String captcha, String phone, String password)
→ Future<String>
-
微信用户绑定手机号
captcha 验证码
phone 绑定手机号
password 设置密码
-
changePhone(String captcha, String proof)
→ Future<String>
-
更换手机号
captcha 新手机验证时发送的验证码
proof 新手机号
-
changePhoneCaptcha(bool sendCaptchaToOldPhone, String proof, String? captcha)
→ Future<String>
-
更换手机号发送验证码
sendCaptchaToOldPhone 是否发送验证码到旧手机
proof 手机号
captcha 向新手机发送验证码
-
checkUpdate(String userId, String protocolVersion, String packageName, String moduleVersion, String language)
→ Future<String>
-
版本更新
userId app用户id
protocolVersion 协议版本，目前暂定为1
packageName 当前应用的包名固定com.maxims
moduleVersion 当前应用版本号，由前缀”maxims_”加上版本号组合而成，比如应用版本号是v1.0.0，那么实际传入的是maxims_v1.0.0
language 语言 zh-中文 en-英文
-
copyProgramById(String userId, String deviceId, String id)
→ Future<String>
-
复制程序
userId app用户id
deviceId 设备id
id 要复制的程序id
-
deleteDeviceScheduleBoot(String userId, String ids)
→ Future<String>
-
更新预约开机记录
userId app用户id
ids 记录id： "xxx,xxx,xxx"
-
删除萃取记录
userId app用户id
ids 萃取记录id，多个逗号分隔
-
deleteMessageNotify(String userId, String ids)
→ Future<String>
-
删除消息通知
userId app用户id
ids 数据id，多条逗号分隔
-
deleteProgram(String userId, String ids)
→ Future<String>
-
删除工作程序
userId app用户id
ids 程序id，多个逗号分隔
-
delUser(String userId)
→ Future<String>
-
用户信息注销账号信息
-
deviceScheduleSwitch(String userId, String deviceId, int mainSwitch)
→ Future<String>
-
预约总开关控制
userId app用户id
deviceId 绑定的设备id
mainSwitch 0-关闭 1-开启
-
favoritesProgram(String userId, String deviceId, String id, int isPick)
→ Future<String>
-
收藏(取消收藏)工作程序
userId app用户id
deviceId 绑定的设备id
id 程序id
isPick 收藏标识 0:取消收藏 1: 收藏
-
formatResponse(Map<String, dynamic> result)
→ String
-
-
getAgreement()
→ Future<String>
-
服务协议
-
getAllRecords(String userId, String deviceId, String? startDate, String? endDate)
→ Future<String>
-
获取所有萃取记录
userId app用户id
deviceId 绑定的设备id
extractType 萃取模式类型，0-标准模式1-专业模式 2-变压模式 3-手动模式 4-滤滴模式
startDate 开始时间，yyyy-MM-dd，为空则是不限制起始时间
endDate 结束时间，yyyy-MM-dd，为空则是不限制结束时间
-
getBindDeviceInfo(String userId)
→ Future<String>
-
获取绑定设备信息
userId app用户id
-
getBindList(String userId)
→ Future<String>
-
获取绑定设备列表信息
userId app用户id
deviceId 绑定的设备id
state 0-关机；1-开机
-
getCopyProgramId(String ids)
→ Future<String>
-
-
getDeviceRealTimeCurve(String userId, String deviceId, String programId)
→ Future<String>
-
获取工作实时曲线
userId app用户id
deviceId 绑定的设备id
programId 程序id
-
getDeviceState(String userId, String deviceId)
→ Future<String>
-
获取设备状态
userId app用户id
deviceId 绑定的设备id
-
getDeviceWorkState(String userId, String deviceId)
→ Future<String>
-
获取设备工作状态
userId app用户id
deviceId 绑定的设备id
-
获取萃取日历统计信息
userId app用户id
deviceId 绑定的设备id
date 日期(年-月)，yyyy-MM 时间精度为月份
-
按时间获取总统计数据
userId app用户id
deviceId 绑定的设备id
startDate 开始时间，yyyy-MM-dd，为空则是不限制起始时间
endDate 结束时间，yyyy-MM-dd，为空则是不限制结束时间
extractType 萃取模式
-
获取萃取详情
userId app用户id
id 萃取记录id
-
获取萃取记录(分页)
getExtractRecordRequestJsonStr 获取萃取记录请求对象的json字符串
-
getGraphicCaptcha(int width, int height)
→ Future<String>
-
获取图形验证码
width 宽 height 高
-
getMessageNotifyList(String userId, String? deviceId, int? readStatus)
→ Future<String>
-
获取消息通知列表
userId app用户id
deviceId 绑定的设备id
readStatus 阅读状态 0-未阅 1-已阅
-
getPhoneCaptcha(String phone)
→ Future<String>
-
获取手机验证码
phone 手机号
-
getProgramDetail(String userId, String deviceId, String id)
→ Future<String>
-
推送工作程序到设备
deviceId 绑定的设备id
id 程序id
-
getProgramListByType(String userId, String deviceId, String deviceModel, int? programType, int pageNo, int? pageSize)
→ Future<String>
-
根据模式获取程序列表(分页)
userId app用户id
deviceId 绑定的设备id
deviceModel 设备型号
programType 程序类型，0-标准程序 1-专业程序 2-变压程序 3-滤滴模式
pageNo 当前页，默认1
pageSize 每页数量，默认10
-
获取最新萃取记录(萃取笔记)
userId app用户id
deviceId 绑定的设备id
-
getTempToken(int type)
→ Future<String>
-
获取临时token
return true 获取成功，false 获取失败
type = 0 : 获取手机验证码
type = 1 : 获取图形验证码
type = 2 : 用户找回密码发送验证码
-
getTextCaptcha()
→ Future<String>
-
获取文本验证码
-
getWorkCorveById(String userId, String id)
→ Future<String>
-
获取所有萃取记录
userId app用户id
id 萃取记录id
-
hideDisplayProgram(String userId, String deviceId, String id, int isHide)
→ Future<String>
-
显示和隐藏工作程序
userId app用户id
deviceId 绑定的设备id
id 程序id
isHide 是否隐藏：0：否 1：是
-
loginWechat(String code, String registrationId, String clientType)
→ Future<String>
-
登录微信
code 微信code
registrationId 设备id
clientType 客户端类型，取值android 或 ios
-
logout()
→ Future<String>
-
退出登录
-
modifyDeviceSysSetting(String deviceSysSettingsJsonStr)
→ Future<String>
-
修改设备系统设置
deviceSysSettingsJsonStr 设备系统设置对象的json字符串
-
modifyLogoImage(File logoImgFile)
→ Future<String>
-
修改头像
logoImgFile 头像文件
-
modifyMessageNotifyStatus(String userId, String id)
→ Future<String>
-
修改消息通知状态
userId app用户id
id 数据id
-
modifyPassword(String oldPassword, String userId, String password)
→ Future<String>
-
修改密码
oldPassword 旧密码
userId 用户id
password 新密码
-
modifyUserInfo(String nickname)
→ Future<String>
-
用户信息修改
nickname 昵称
-
phoneLogin(String? captcha, String proof, String password, String registrationId, String clientType)
→ Future<String>
-
手机号登录
captcha 验证码
proof 手机号
password 密码
registrationId App在登录时传递过来的极光推送的registrationId（这个表示的是推送id）
clientType 客户端类型，取值android 或 ios
-
phoneRegister(String captcha, String phone, String password)
→ Future<String>
-
手机号注册
captcha 验证码
phone 手机号
password 密码
-
pushProgram(String userId, String deviceId, String id)
→ Future<String>
-
推送工作程序到设备
userId app用户id
deviceId 绑定的设备id
id 要推送的程序id
-
queryUserInfo(String userId)
→ Future<String>
-
获取当前用户信息
userId 用户id
-
recoveryPassword(String captcha, String proof, String password)
→ Future
-
用户找回密码执行修改
captcha 验证码
proof 手机号
password 新密码
-
recoveryPasswordCaptcha(String proof)
→ Future<String>
-
用户找回密码发送验证码
proof 手机号
-
removeUser()
→ Future<String>
-
注销用户
-
selectBindServer(String userId, String deviceId, int selectStatus)
→ Future<String>
-
APP选中/取消选中默认设备
userId app用户id
deviceId 绑定的设备id
selectStatus 状态，0-未选中；1-选中
-
setDevicePowerState(String userId, String deviceId, int state)
→ Future<String>
-
远程开关机
userId app用户id
deviceId 绑定的设备id
state 0-关机；1-开机
-
setProgramWorkState(String userId, String deviceId, String programId, int workCmd)
→ Future<String>
-
指定工作程序工作状态(开始工作请用startProgramWork接口)
userId app用户id
deviceId 绑定的设备id
programId 程序id
workCmd 工作指令，0-结束
-
startProgramWork(String workParamsInfo)
→ Future<String>
-
指定工作程序工作状态
workParamsInfo 开始工作参数
-
syncDeviceScheduleBoot(String userId, String deviceId)
→ Future<String>
-
同步设备预约开机记录
userId app用户id
deviceId 绑定的设备id
-
syncDeviceSysSetting(String userId, String deviceId)
→ Future
-
同步设备系统设置
userId app用户id
deviceId 绑定的设备id
-
unBindDevice(String userId, String deviceId, int? deviceDataReserved)
→ Future<String>
-
APP解绑设备
userId app用户id
deviceId 要解绑的设备id
deviceDataReserved 可空字段 解绑时是否要保留设备端数据，不传表示不保留 0-不保留1-保留
-
updateDeviceScheduleBoot(String deviceScheduleBootJsonStr)
→ Future<String>
-
更新预约开机记录
deviceScheduleBootJsonStr 设备开机记录对象的json字符串
-
更新萃取记录
updateExtractRecordNoteJsonStr 更新萃取记录请求对象的json字符串
-
updateProgram(String programInfoJsonStr)
→ Future<String>
-
更新工作程序
programInfoJsonStr 新增工作程序请求对象的json字符串
