46 Star 176 Fork 4.8K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.update.d.ts 60.18 KB
一键复制 编辑 原始数据 按行查看 历史
甘罗宇 提交于 2个月前 . 修改格式otamode
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit BasicServicesKit
*/
import type { AsyncCallback } from './@ohos.base';
/**
* A static class to do update for device.
*
* @namespace update
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
declare namespace update {
/**
* Get online update handler for the calling device.
*
* @param { UpgradeInfo } upgradeInfo - Indicates client app and business type.
* @returns { Updater } online update handler to perform online update.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
function getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater;
/**
* Get restore handler.
*
* @returns { Restorer } restore handler to perform factory reset.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
function getRestorer(): Restorer;
/**
* Get local update handler.
*
* @returns { LocalUpdater } local update handler to perform local update.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
function getLocalUpdater(): LocalUpdater;
/**
* A static class to do online update.
*
* @interface Updater
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface Updater {
/**
* Check new version.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { AsyncCallback<CheckResult> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
checkNewVersion(callback: AsyncCallback<CheckResult>): void;
/**
* Check new version.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @returns { Promise<CheckResult> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
checkNewVersion(): Promise<CheckResult>;
/**
* Get new version.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { AsyncCallback<NewVersionInfo> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getNewVersionInfo(callback: AsyncCallback<NewVersionInfo>): void;
/**
* Get new version.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @returns { Promise<NewVersionInfo> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getNewVersionInfo(): Promise<NewVersionInfo>;
/**
* Get new version description.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { DescriptionOptions } descriptionOptions - Options of the description file.
* @param { AsyncCallback<Array<ComponentDescription>> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getNewVersionDescription(
versionDigestInfo: VersionDigestInfo,
descriptionOptions: DescriptionOptions,
callback: AsyncCallback<Array<ComponentDescription>>
): void;
/**
* Get new version description.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { DescriptionOptions } descriptionOptions - Options of the description file.
* @returns { Promise<Array<ComponentDescription>> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getNewVersionDescription(
versionDigestInfo: VersionDigestInfo,
descriptionOptions: DescriptionOptions
): Promise<Array<ComponentDescription>>;
/**
* Get current version.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { AsyncCallback<CurrentVersionInfo> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getCurrentVersionInfo(callback: AsyncCallback<CurrentVersionInfo>): void;
/**
* Get current version.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @returns { Promise<CurrentVersionInfo> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getCurrentVersionInfo(): Promise<CurrentVersionInfo>;
/**
* Get current version description.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { DescriptionOptions } descriptionOptions - Options of the description file.
* @param { AsyncCallback<Array<ComponentDescription>> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getCurrentVersionDescription(
descriptionOptions: DescriptionOptions,
callback: AsyncCallback<Array<ComponentDescription>>
): void;
/**
* Get current version description.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { DescriptionOptions } descriptionOptions - Options of the description file.
* @returns { Promise<Array<ComponentDescription>> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise<Array<ComponentDescription>>;
/**
* Get task info.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { AsyncCallback<TaskInfo> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getTaskInfo(callback: AsyncCallback<TaskInfo>): void;
/**
* Get task info.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @returns { Promise<TaskInfo> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getTaskInfo(): Promise<TaskInfo>;
/**
* Trigger download new version packages.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { DownloadOptions } downloadOptions - Download options.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
download(
versionDigestInfo: VersionDigestInfo,
downloadOptions: DownloadOptions,
callback: AsyncCallback<void>
): void;
/**
* Trigger download new version packages.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { DownloadOptions } downloadOptions - Download options.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions): Promise<void>;
/**
* Resume download new version packages.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { ResumeDownloadOptions } resumeDownloadOptions - Options for resume download.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
resumeDownload(
versionDigestInfo: VersionDigestInfo,
resumeDownloadOptions: ResumeDownloadOptions,
callback: AsyncCallback<void>
): void;
/**
* Resume download new version packages.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { ResumeDownloadOptions } resumeDownloadOptions - Options for resume download.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions): Promise<void>;
/**
* Pause download new version packages.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { PauseDownloadOptions } pauseDownloadOptions - Options for pause download.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
pauseDownload(
versionDigestInfo: VersionDigestInfo,
pauseDownloadOptions: PauseDownloadOptions,
callback: AsyncCallback<void>
): void;
/**
* Pause download new version packages.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { PauseDownloadOptions } pauseDownloadOptions - Options for pause download.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions): Promise<void>;
/**
* Install packages for the device.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { UpgradeOptions } upgradeOptions - Update options.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, callback: AsyncCallback<void>): void;
/**
* Install packages for the device.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { UpgradeOptions } upgradeOptions - Update options.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): Promise<void>;
/**
* Clear error during upgrade.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { ClearOptions } clearOptions - Clear options.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, callback: AsyncCallback<void>): void;
/**
* Clear error during upgrade.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { VersionDigestInfo } versionDigestInfo - Version digest information.
* @param { ClearOptions } clearOptions - Clear options.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Promise<void>;
/**
* Get current upgrade policy.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { AsyncCallback<UpgradePolicy> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getUpgradePolicy(callback: AsyncCallback<UpgradePolicy>): void;
/**
* Get current upgrade policy.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @returns { Promise<UpgradePolicy> } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
getUpgradePolicy(): Promise<UpgradePolicy>;
/**
* Set upgrade policy.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { UpgradePolicy } policy - Update policy.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback<void>): void;
/**
* Set upgrade policy.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { UpgradePolicy } policy - Update policy.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
setUpgradePolicy(policy: UpgradePolicy): Promise<void>;
/**
* Terminate upgrade task.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, 'err' is 'undefined'; otherwise, 'err' is an 'Error' object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
terminateUpgrade(callback: AsyncCallback<void>): void;
/**
* Terminate upgrade task.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
terminateUpgrade(): Promise<void>;
/**
* Subscribe task update events
*
* @param { EventClassifyInfo } eventClassifyInfo - Event information.
* @param { UpgradeTaskCallback } taskCallback - Event callback.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void;
/**
* Unsubscribe task update events
*
* @param { EventClassifyInfo } eventClassifyInfo - Event information.
* @param { UpgradeTaskCallback } taskCallback - Event callback.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void;
}
/**
* A static class to do restore.
*
* @interface Restorer
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface Restorer {
/**
* Reboot and clean user data.
*
* @permission ohos.permission.FACTORY_RESET
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
factoryReset(callback: AsyncCallback<void>): void;
/**
* Reboot and clean user data.
*
* @permission ohos.permission.FACTORY_RESET
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
factoryReset(): Promise<void>;
}
/**
* A static class to do local update.
*
* @interface LocalUpdater
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface LocalUpdater {
/**
* Verify local update package.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { UpgradeFile } upgradeFile - Update file.
* @param { string } certsFile - Path of the certificate file.
* @param { AsyncCallback<void> } callback - Callback used to return the verify upgrade package result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: AsyncCallback<void>): void;
/**
* Verify local update package.
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { UpgradeFile } upgradeFile - Update file.
* @param { string } certsFile - Path of the certificate file.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise<void>;
/**
* Apply local update package.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { Array<UpgradeFile> } upgradeFiles - Update files.
* @param { AsyncCallback<void> } callback - Callback used to return the apply new version result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
applyNewVersion(upgradeFiles: Array<UpgradeFile>, callback: AsyncCallback<void>): void;
/**
* Apply local update package.
* Apps should listen to task update event
*
* @permission ohos.permission.UPDATE_SYSTEM
* @param { Array<UpgradeFile> } upgradeFiles - Update files.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter verification failed.
* @throws { BusinessError } 11500104 - IPC error.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
applyNewVersion(upgradeFiles: Array<UpgradeFile>): Promise<void>;
/**
* Subscribe task update events
*
* @param { EventClassifyInfo } eventClassifyInfo - Event information.
* @param { UpgradeTaskCallback } taskCallback - Event callback.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void;
/**
* Unsubscribe task update events
*
* @param { EventClassifyInfo } eventClassifyInfo - Event information.
* @param { UpgradeTaskCallback } taskCallback - Event callback.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void;
}
/**
* Represents upgrade info.
*
* @typedef UpgradeInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface UpgradeInfo {
/**
* Upgrade client package name
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
upgradeApp: string;
/**
* BusinessType of upgrade
*
* @type { BusinessType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
businessType: BusinessType;
}
/**
* Represents business type.
*
* @typedef BusinessType
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface BusinessType {
/**
* Vendor of business type
*
* @type { BusinessVendor }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
vendor: BusinessVendor;
/**
* Update service type
*
* @type { BusinessSubType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
subType: BusinessSubType;
}
/**
* Represents new version check result.
*
* @typedef CheckResult
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface CheckResult {
/**
* New version exist or not
*
* @type { boolean }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
isExistNewVersion: boolean;
/**
* New version info
*
* @type { NewVersionInfo }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
newVersionInfo: NewVersionInfo;
}
/**
* Represents new version info.
*
* @typedef NewVersionInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface NewVersionInfo {
/**
* Digest info of new version
*
* @type { VersionDigestInfo }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
versionDigestInfo: VersionDigestInfo;
/**
* New version component array
*
* @type { Array<VersionComponent> }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
versionComponents: Array<VersionComponent>;
}
/**
* Represents version digest info.
*
* @typedef VersionDigestInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface VersionDigestInfo {
/**
* Version digest value
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
versionDigest: string;
}
/**
* Represents version component info.
*
* @typedef VersionComponent
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface VersionComponent {
/**
* Version component id
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
componentId: string;
/**
* Version component type
*
* @type { ComponentType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
componentType: ComponentType;
/**
* Upgrade action
*
* @type { UpgradeAction }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
upgradeAction: UpgradeAction;
/**
* Display version number
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
displayVersion: string;
/**
* Internal version number
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
innerVersion: string;
/**
* Update package size
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
size: number;
/**
* Effective mode
*
* @type { EffectiveMode }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
effectiveMode: EffectiveMode;
/**
* Information about the version description file
*
* @type { DescriptionInfo }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
descriptionInfo: DescriptionInfo;
/**
* Ota mode
*
* @type { ?OtaMode }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 20
*/
otaMode?: OtaMode;
}
/**
* Represents description options.
*
* @typedef DescriptionOptions
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface DescriptionOptions {
/**
* Format of the description file
*
* @type { DescriptionFormat }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
format: DescriptionFormat;
/**
* Language of the description file
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
language: string;
}
/**
* Represents version component description.
*
* @typedef ComponentDescription
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface ComponentDescription {
/**
* Component id
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
componentId: string;
/**
* Information about the description file
*
* @type { DescriptionInfo }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
descriptionInfo: DescriptionInfo;
}
/**
* Represents new version description information.
*
* @typedef DescriptionInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface DescriptionInfo {
/**
* Description content type
*
* @type { DescriptionType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
descriptionType: DescriptionType;
/**
* Content of the description file
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
content: string;
}
/**
* Represents current version info.
*
* @typedef CurrentVersionInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface CurrentVersionInfo {
/**
* System version number
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
osVersion: string;
/**
* Device name
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
deviceName: string;
/**
* Current version component array
*
* @type { Array<VersionComponent> }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
versionComponents: Array<VersionComponent>;
}
/**
* Represents download options.
*
* @typedef DownloadOptions
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface DownloadOptions {
/**
* Allow download with the network type
*
* @type { NetType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
allowNetwork: NetType;
/**
* Upgrade command
*
* @type { Order }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
order: Order;
}
/**
* Represents resume download options.
*
* @typedef ResumeDownloadOptions
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface ResumeDownloadOptions {
/**
* Allow download with the network type
*
* @type { NetType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
allowNetwork: NetType;
}
/**
* Represents pause download options.
*
* @typedef PauseDownloadOptions
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface PauseDownloadOptions {
/**
* Whether allow auto resume when net available
*
* @type { boolean }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
isAllowAutoResume: boolean;
}
/**
* Represents upgrade options.
*
* @typedef UpgradeOptions
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface UpgradeOptions {
/**
* Upgrade command
*
* @type { Order }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
order: Order;
}
/**
* Represents clear error options.
*
* @typedef ClearOptions
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface ClearOptions {
/**
* Clear status error
*
* @type { UpgradeStatus }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
status: UpgradeStatus;
}
/**
* Represents upgrade policy.
*
* @typedef UpgradePolicy
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface UpgradePolicy {
/**
* Download strategy: open or close
*
* @type { boolean }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
downloadStrategy: boolean;
/**
* Auto upgrade strategy: open or close
*
* @type { boolean }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
autoUpgradeStrategy: boolean;
/**
* Auto upgrade period
*
* @type { Array<UpgradePeriod> }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
autoUpgradePeriods: Array<UpgradePeriod>;
}
/**
* Represents upgrade period.
*
* @typedef UpgradePeriod
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface UpgradePeriod {
/**
* Start time of upgrade period
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
start: number;
/**
* End time of upgrade period
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
end: number;
}
/**
* Represents task info.
*
* @typedef TaskInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface TaskInfo {
/**
* Whether upgrade task exist
*
* @type { boolean }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
existTask: boolean;
/**
* Task body info
*
* @type { TaskBody }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
taskBody: TaskBody;
}
/**
* Represents event info.
*
* @typedef EventInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface EventInfo {
/**
* Event id
*
* @type { EventId }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
eventId: EventId;
/**
* Task body info
*
* @type { TaskBody }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
taskBody: TaskBody;
}
/**
* Represents task body info.
*
* @typedef TaskBody
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface TaskBody {
/**
* Digest info of new version
*
* @type { VersionDigestInfo }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
versionDigestInfo: VersionDigestInfo;
/**
* Upgrade status
*
* @type { UpgradeStatus }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
status: UpgradeStatus;
/**
* Upgrade sub status
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
subStatus: number;
/**
* Upgrade progress
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
progress: number;
/**
* Install mode
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
installMode: number;
/**
* Error messages
*
* @type { Array<ErrorMessage> }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
errorMessages: Array<ErrorMessage>;
/**
* Version component array
*
* @type { Array<VersionComponent> }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
versionComponents: Array<VersionComponent>;
}
/**
* Represents error message.
*
* @typedef ErrorMessage
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface ErrorMessage {
/**
* Error code
*
* @type { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
errorCode: number;
/**
* Error message
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
errorMessage: string;
}
/**
* Represents event classify info.
*
* @typedef EventClassifyInfo
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface EventClassifyInfo {
/**
* Event classify
*
* @type { EventClassify }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
eventClassify: EventClassify;
/**
* Additional information
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
extraInfo: string;
}
/**
* Represents upgrade file info.
*
* @typedef UpgradeFile
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface UpgradeFile {
/**
* Upgrade file type
*
* @type { ComponentType }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
fileType: ComponentType;
/**
* Upgrade file path
*
* @type { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
filePath: string;
}
/**
* Called when upgrade task info changes.
* You need to implement this method in a child class.
*
* @typedef UpgradeTaskCallback
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export interface UpgradeTaskCallback {
/**
* Event callback.
*
* @param { EventInfo } eventInfo - Event information.
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
(eventInfo: EventInfo): void;
}
/**
* Enumerates business vendor type.
*
* @enum { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum BusinessVendor {
/**
* Device vendor is open source.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
PUBLIC = 'public'
}
/**
* Enumerates business sub type.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum BusinessSubType {
/**
* Business sub type is Firmware.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
FIRMWARE = 1
}
/**
* Enumerates component type.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum ComponentType {
/**
* Component type is OTA.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
OTA = 1
}
/**
* Enumerates upgrade action type.
*
* @enum { string }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum UpgradeAction {
/**
* Differential package.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
UPGRADE = 'upgrade',
/**
* Recovery package.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
RECOVERY = 'recovery'
}
/**
* Enumerates effective mode.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum EffectiveMode {
/**
* Cold update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
COLD = 1,
/**
* Live update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
LIVE = 2,
/**
* Hybrid live and cold update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
LIVE_AND_COLD = 3
}
/**
* Enumerates ota mode.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 20
*/
export enum OtaMode {
/**
* Regular update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 20
*/
REGULAR_OTA = 0,
/**
* Stream update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 20
*/
STREAM_OTA = 1,
/**
* AB regular update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 20
*/
AB_REGULAR_OTA = 2,
/**
* AB stream update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 20
*/
AB_STREAM_OTA = 3
}
/**
* Enumerates description type.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum DescriptionType {
/**
* Description type is content.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
CONTENT = 0,
/**
* Description type is link.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
URI = 1
}
/**
* Enumerates description format.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum DescriptionFormat {
/**
* Description format is standard format.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
STANDARD = 0,
/**
* Description format is Simple format.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
SIMPLIFIED = 1
}
/**
* Enumerates network type.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum NetType {
/**
* Network type is data network.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
CELLULAR = 1,
/**
* Network type is Wi-Fi hotspot.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
METERED_WIFI = 2,
/**
* Network type is non Wi-Fi hotspot.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
NOT_METERED_WIFI = 4,
/**
* Network type is Wi-Fi.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
WIFI = 6,
/**
* Network type is data network and Wi-Fi.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
CELLULAR_AND_WIFI = 7
}
/**
* Enumerates upgrade order.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum Order {
/**
* Upgrade order is download.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
DOWNLOAD = 1,
/**
* Upgrade order is Install.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
INSTALL = 2,
/**
* Upgrade order is download and install.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
DOWNLOAD_AND_INSTALL = 3,
/**
* Upgrade order is apply.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
APPLY = 4,
/**
* Upgrade order is install and apply.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
INSTALL_AND_APPLY = 6
}
/**
* Enumerates upgrade status.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum UpgradeStatus {
/**
* Upgrade status is waiting for download.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
WAITING_DOWNLOAD = 20,
/**
* Upgrade status is downloading.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
DOWNLOADING = 21,
/**
* Upgrade status is download paused.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
DOWNLOAD_PAUSED = 22,
/**
* Upgrade status is download failed.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
DOWNLOAD_FAIL = 23,
/**
* Upgrade status is waiting for installation.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
WAITING_INSTALL = 30,
/**
* Upgrade status is upgrading.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
UPDATING = 31,
/**
* Upgrade status is waiting for applying the update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
WAITING_APPLY = 40,
/**
* Upgrade status is applying the update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
APPLYING = 41,
/**
* Upgrade status is update succeeded.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
UPGRADE_SUCCESS = 50,
/**
* Upgrade status is update failed.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
UPGRADE_FAIL = 51
}
/**
* Enumerates event classify.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum EventClassify {
/**
* Event classify is task event.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
TASK = 0x01000000
}
/**
* Enumerates event id.
*
* @enum { number }
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
export enum EventId {
/**
* Event id is task event.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_TASK_BASE = EventClassify.TASK,
/**
* Event id is task received.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_TASK_RECEIVE,
/**
* Event id is task cancelled.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_TASK_CANCEL,
/**
* Event id is waiting for download.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_WAIT,
/**
* Event id is download started.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_START,
/**
* Event id is download progress update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_UPDATE,
/**
* Event id is download paused.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_PAUSE,
/**
* Event id is download resumed.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_RESUME,
/**
* Event id is download succeeded.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_SUCCESS,
/**
* Event id is download failed.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_DOWNLOAD_FAIL,
/**
* Event id is waiting for update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_UPGRADE_WAIT,
/**
* Event id is update started.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_UPGRADE_START,
/**
* Event id is update in progress.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_UPGRADE_UPDATE,
/**
* Event id is waiting for applying the update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_APPLY_WAIT,
/**
* Event id is applying the update.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_APPLY_START,
/**
* Event id is update succeeded.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_UPGRADE_SUCCESS,
/**
* Event id is update failed.
*
* @syscap SystemCapability.Update.UpdateService
* @systemapi hide for inner use.
* @since 9
*/
EVENT_UPGRADE_FAIL
}
}
export default update;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助