1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.update.d.ts 59.10 KB
一键复制 编辑 原始数据 按行查看 历史
邹友松 提交于 2024-07-25 19:20 +08:00 . 修改 202 错误码注释
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073
/*
* 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;
}
/**
* 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 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/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助