HarmonySpeakPenSDK
介紹
鴻蒙版好學(xué)多點(diǎn)讀筆api，本SDK以靜態(tài)庫(kù)的方式進(jìn)行封裝，導(dǎo)入項(xiàng)目使用，本SDK僅限于指定合作方使用，未經(jīng)我公司允許私自使用本SDK造成我公司的損失，由使用者承擔(dān)。
當(dāng)前版本號(hào)
1.0.0
本SDK采用本地導(dǎo)入方式安裝，教程教程如下
- 拷貝SpeakPen.har到您的項(xiàng)目中
- 找到項(xiàng)目的oh-package.json5文件配置對(duì)應(yīng)的路徑，已Demo為例，路徑如下
"dependencies": {
"SpeakPen": "file:./src/main/SpeakPen1.0.0.har"
}
-
添加完后上方會(huì)出現(xiàn)如下圖的提示，然后點(diǎn)擊Sync Now同步此SDK
- 此SDK需要使用網(wǎng)絡(luò)權(quán)限，如未添加網(wǎng)絡(luò)權(quán)限需要自行添加
- SDK中的Api調(diào)用方法參考Demo
SDK接口說(shuō)明
1.STPDeviceApi
/**
獲取用戶的所有設(shè)備
@param currDetail 是否顯示當(dāng)前控制設(shè)備的詳情 YES等于同時(shí)調(diào)用getDeviceDetail
*/
getDeviceList(currDetail:boolean) : Promise<STPDeviceInfo|null>
/**
獲取設(shè)備詳細(xì)信息
*/
getDeviceDetail() : Promise<STPDeviceInfo|null>
//獲取設(shè)備硬件信息
getHardwareInfo() : Promise<STPHardwareInfo|null>
/**
修改設(shè)備的名稱
@param deviceName 新的名稱
*/
updateDeviceName(deviceName : string) : Promise<STPBaseInfo|null>
/**
修改設(shè)備音量
@param voiceValue 音量值 最小值0 最大值100
*/
changeDeviceVolume(voiceValue : number) : Promise<STPBaseInfo|null>
2.STPAuthApi
// ------------------- 用戶登錄 ------------------------
getLoginData(phoneNum:string,passWord:string,pushId:string) : Promise<STPUserInfo|null>
/**
用戶手機(jī)號(hào)碼是否注冊(cè)
@param phoneNum 手機(jī)號(hào)碼
@param completionBlock IsRegist 1 = 注冊(cè) 0=未注冊(cè)
*/
isRegist(phoneNum:string) : Promise<STPisRegist|null>
3.STPWordDeviceNetworkApi
/// 獲取設(shè)備詞庫(kù)列表設(shè)置 （多詞庫(kù)版本）
/// otype 類型，0 public 1 appId 2 user 3 sn，本次用戶自定詞庫(kù)設(shè)置為2
/// @param block block
getDeviceWordDictListWith(oType:number) : Promise<STPWordDeviceDictDetailInfo|null>
/// 查詢?cè)~庫(kù)列表
/// @param categoryId 分類id，查詢?cè)摲诸愐约捌渥臃诸愊碌臄?shù)據(jù)
/// @param ids 詞庫(kù)id
/// @param dictType 詞典類型 （單詞機(jī)填寫 @"small" 小型詞庫(kù)，適用于 卡片機(jī)）
/// @param oType 類型，public:0,appId:1,user:2,sn:3，(用戶自定詞庫(kù)設(shè)置為2)
/// @param owner 根據(jù)oType填寫，如果是用戶自定詞庫(kù)設(shè)置為具體的userId
/// @param page 分頁(yè)，第幾頁(yè)，默認(rèn)1
/// @param pageSize 分頁(yè)，每頁(yè)條數(shù)，默認(rèn)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表示獲取首頁(yè)（必選）
@param count 每頁(yè)返回的數(shù)量，可選范圍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>
/// 下載繪本或點(diǎn)讀包
/// @param picBookId 需要傳入資源的 mid參數(shù)
addBookDownloadToDevice(picBookId:string) : Promise<STPBaseInfo|null>
/// 刪除繪本（單本、批量：批量每次最多刪除10個(gè)數(shù)據(jù)）
/// @param aIDs 繪本ID
deleteDeviceBooks(aIDs:string[]) : Promise<STPBaseInfo|null>
/**
獲取設(shè)備已添加繪本列表
@param resourceID 最后一條繪本ID，0表示獲取首頁(yè)（必選）
@param count 每頁(yè)返回的數(shù)量，可選范圍1-50，建議值20 （必選）
*/
getLocalPicbookList(resourceID:number,count:number) : Promise<STPPicBookResourceListInfo|null>
//獲取設(shè)備端存儲(chǔ)卡容量信息
getSdcardInfo() : Promise<STPSdcardInfo|null>
/**
獲取已添加到設(shè)備上的點(diǎn)讀包列表
@param resourceID 最后一條點(diǎn)讀包ID，0表示獲取首頁(yè)（必選）
@param count 每頁(yè)返回的數(shù)量，可選范圍1-50，建議值20 （必選）
*/
getLocalPackageList(resourceID:number,count:number) : Promise<STPPicBookDetailInfo|null>
/**
獲取全部可用的點(diǎn)讀包列表
@param resourceID 最后一條繪本ID，0表示獲取首頁(yè)（必選）
@param count 每頁(yè)返回的數(shù)量，可選范圍1-50，建議值20 （必選）
*/
getAllPackageListResourceId(resourceID:number,count:number) : Promise<STPPicBookResourceInfo|null>
5.STPStudyReportApi
/// 各項(xiàng)學(xué)習(xí)數(shù)據(jù) (根據(jù)時(shí)間)
/// @param type 候選值對(duì)應(yīng)的字符串(獲取跟讀數(shù)據(jù) 傳 @"follow-reading")
/// 1: 點(diǎn)讀數(shù)量(point-reading)
/// 2：繪本閱讀量 (pic-book)
/// 3：學(xué)習(xí)時(shí)長(zhǎng)(duration)
/// 4：跟讀次數(shù) (follow-reading)
/// @param start 起始日期 格式 YYYY-MM-DD（當(dāng)天的話 start、end 都傳同一個(gè)值）
/// @param end 終止日期
getStudyAchieveData(type:string,start:string,end:string) : Promise<STPFollowReadResultInfo|null>
/// 各項(xiàng)學(xué)習(xí)數(shù)據(jù) (根據(jù)順序)
/// @param type 候選值對(duì)應(yīng)的字符串(獲取跟讀數(shù)據(jù) 傳 @"follow-reading")
/// 1: 點(diǎn)讀數(shù)量(point-reading)
/// 2：繪本閱讀量 (pic-book)
/// 3：學(xué)習(xí)時(shí)長(zhǎng)(duration)
/// 4：跟讀次數(shù) (follow-reading)
/// @param fromId 數(shù)據(jù)起始ID ，0表示最新的數(shù)據(jù)
/// @param count 數(shù)量
/// @param block block
getStudyAchieveSequenceData(type:string,fromId:number,count:number) : Promise<STPFollowReadResultInfo|null>
/// 獲取已讀繪本列表(根據(jù)時(shí)間)
/// @param start 起始日期 格式 YYYY-MM-DD （當(dāng)天的話 start、end 都傳同一個(gè)值）
/// @param end 終止日期
/// @param block block
getTodayReadBookListStartDate(start:string,end:string) : Promise<STPFollowReadResultInfo|null>
/// 獲取已讀繪本列表(根據(jù)順序)
/// @param fromId 數(shù)據(jù)起始ID ，0表示最新的數(shù)據(jù)
/// @param count 數(shù)量
/// @param block block
getTodayReadBookListFromId(fromId:number,count:number) : Promise<STPFollowReadResultInfo|null>
/// 獲取各項(xiàng)報(bào)告趨勢(shì)詳情
/// @param type (數(shù)據(jù)類型 例如：獲取點(diǎn)讀次數(shù) 傳@"point-reading")
/// 1: 點(diǎn)讀數(shù)量(point-reading)
/// 2：學(xué)習(xí)時(shí)長(zhǎng)(duration)
/// @param start 起始日期 格式 YYYY-MM-DD （當(dāng)天的話 start、end 都傳同一個(gè)值）
/// @param end 終止日期
/// @param block block
getPassdayTrendListWithType(type:string,start:string,end:string) : Promise<STPTrendListInfo|null>
