2024-08-10
2024-08-09 本文已影响0人
攻城狮GG
HarmonySpeakPenSDK
介绍
鸿蒙版好学多点读笔api，本SDK以静态库的方式进行封装，导入项目使用，本SDK仅限于指定合作方使用，未经我公司允许私自使用本SDK造成我公司的损失，由使用者承担。
当前版本号
1.0.0
本SDK采用本地导入方式安装，教程教程如下
- 拷贝SpeakPen.har到您的项目中
- 找到项目的oh-package.json5文件配置对应的路径，已Demo为例，路径如下
"dependencies": {
"SpeakPen": "file:./src/main/SpeakPen1.0.0.har"
}
-
添加完后上方会出现如下图的提示，然后点击Sync Now同步此SDK
- 此SDK需要使用网络权限，如未添加网络权限需要自行添加
- SDK中的Api调用方法参考Demo
SDK接口说明
1.STPDeviceApi
/**
获取用户的所有设备
@param currDetail 是否显示当前控制设备的详情 YES等于同时调用getDeviceDetail
*/
getDeviceList(currDetail:boolean) : Promise<STPDeviceInfo|null>
/**
获取设备详细信息
*/
getDeviceDetail() : Promise<STPDeviceInfo|null>
//获取设备硬件信息
getHardwareInfo() : Promise<STPHardwareInfo|null>
/**
修改设备的名称
@param deviceName 新的名称
*/
updateDeviceName(deviceName : string) : Promise<STPBaseInfo|null>
/**
修改设备音量
@param voiceValue 音量值 最小值0 最大值100
*/
changeDeviceVolume(voiceValue : number) : Promise<STPBaseInfo|null>
2.STPAuthApi
// ------------------- 用户登录 ------------------------
getLoginData(phoneNum:string,passWord:string,pushId:string) : Promise<STPUserInfo|null>
/**
用户手机号码是否注册
@param phoneNum 手机号码
@param completionBlock IsRegist 1 = 注册 0=未注册
*/
isRegist(phoneNum:string) : Promise<STPisRegist|null>
3.STPWordDeviceNetworkApi
/// 获取设备词库列表设置 （多词库版本）
/// otype 类型，0 public 1 appId 2 user 3 sn，本次用户自定词库设置为2
/// @param block block
getDeviceWordDictListWith(oType:number) : Promise<STPWordDeviceDictDetailInfo|null>
/// 查询词库列表
/// @param categoryId 分类id，查询该分类以及其子分类下的数据
/// @param ids 词库id
/// @param dictType 词典类型 （单词机填写 @"small" 小型词库，适用于 卡片机）
/// @param oType 类型，public:0,appId:1,user:2,sn:3，(用户自定词库设置为2)
/// @param owner 根据oType填写，如果是用户自定词库设置为具体的userId
/// @param page 分页，第几页，默认1
/// @param pageSize 分页，每页条数，默认20，最大500
/// @param block block
getWordDictCategoryWithCategoryId(categoryId:number,ids:number[],dictType:string,oType:number,page:number,pageSize:number,owner:string) : Promise<STPWordDeviceDictDetailInfo|null>
4.STPPictureBookApi
/**
获取绘本资源列表
@param resourceID 最后一条绘本ID，0表示获取首页（必选）
@param count 每页返回的数量，可选范围1-50，建议值20 （必选）
*/
getAllPicbookList(resourceID:number,count:number) : Promise<STPPicBookResourceListInfo|null>
/**
搜索绘本资源列表
@param picBookName 绘本名称
*/
searchPicbookList(picBookName:string) : Promise<STPPicBookResourceListInfo|null>
/// 获取绘本详情
/// @param picBookId 绘本ID
getPicbookDetail(picBookId:string) : Promise<STPPicBookDetailInfo|null>
/// 下载绘本或点读包
/// @param picBookId 需要传入资源的 mid参数
addBookDownloadToDevice(picBookId:string) : Promise<STPBaseInfo|null>
/// 删除绘本（单本、批量：批量每次最多删除10个数据）
/// @param aIDs 绘本ID
deleteDeviceBooks(aIDs:string[]) : Promise<STPBaseInfo|null>
/**
获取设备已添加绘本列表
@param resourceID 最后一条绘本ID，0表示获取首页（必选）
@param count 每页返回的数量，可选范围1-50，建议值20 （必选）
*/
getLocalPicbookList(resourceID:number,count:number) : Promise<STPPicBookResourceListInfo|null>
//获取设备端存储卡容量信息
getSdcardInfo() : Promise<STPSdcardInfo|null>
/**
获取已添加到设备上的点读包列表
@param resourceID 最后一条点读包ID，0表示获取首页（必选）
@param count 每页返回的数量，可选范围1-50，建议值20 （必选）
*/
getLocalPackageList(resourceID:number,count:number) : Promise<STPPicBookDetailInfo|null>
/**
获取全部可用的点读包列表
@param resourceID 最后一条绘本ID，0表示获取首页（必选）
@param count 每页返回的数量，可选范围1-50，建议值20 （必选）
*/
getAllPackageListResourceId(resourceID:number,count:number) : Promise<STPPicBookResourceInfo|null>
5.STPStudyReportApi
/// 各项学习数据 (根据时间)
/// @param type 候选值对应的字符串(获取跟读数据 传 @"follow-reading")
/// 1: 点读数量(point-reading)
/// 2：绘本阅读量 (pic-book)
/// 3：学习时长(duration)
/// 4：跟读次数 (follow-reading)
/// @param start 起始日期 格式 YYYY-MM-DD（当天的话 start、end 都传同一个值）
/// @param end 终止日期
getStudyAchieveData(type:string,start:string,end:string) : Promise<STPFollowReadResultInfo|null>
/// 各项学习数据 (根据顺序)
/// @param type 候选值对应的字符串(获取跟读数据 传 @"follow-reading")
/// 1: 点读数量(point-reading)
/// 2：绘本阅读量 (pic-book)
/// 3：学习时长(duration)
/// 4：跟读次数 (follow-reading)
/// @param fromId 数据起始ID ，0表示最新的数据
/// @param count 数量
/// @param block block
getStudyAchieveSequenceData(type:string,fromId:number,count:number) : Promise<STPFollowReadResultInfo|null>
/// 获取已读绘本列表(根据时间)
/// @param start 起始日期 格式 YYYY-MM-DD （当天的话 start、end 都传同一个值）
/// @param end 终止日期
/// @param block block
getTodayReadBookListStartDate(start:string,end:string) : Promise<STPFollowReadResultInfo|null>
/// 获取已读绘本列表(根据顺序)
/// @param fromId 数据起始ID ，0表示最新的数据
/// @param count 数量
/// @param block block
getTodayReadBookListFromId(fromId:number,count:number) : Promise<STPFollowReadResultInfo|null>
/// 获取各项报告趋势详情
/// @param type (数据类型 例如：获取点读次数 传@"point-reading")
/// 1: 点读数量(point-reading)
/// 2：学习时长(duration)
/// @param start 起始日期 格式 YYYY-MM-DD （当天的话 start、end 都传同一个值）
/// @param end 终止日期
/// @param block block
getPassdayTrendListWithType(type:string,start:string,end:string) : Promise<STPTrendListInfo|null>
