/* * Copyright (c) 2023 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. */ import update from '@ohos.update'; /** * å‡çº§çŠ¶æ€ * * @since 2022-06-05 */ export enum UpdateState { /** * åˆå§‹çŠ¶æ€ */ INIT = 0, /** * 状æ€--æœåŒ…æˆåŠŸ */ CHECK_SUCCESS = 12, /** * 状æ€--ä¸‹è½½ä¸ */ DOWNLOADING = 20, /** * 状æ€--ä¸‹è½½æš‚åœ */ DOWNLOAD_PAUSE = 21, /** * 状æ€--å–æ¶ˆä¸‹è½½ */ DOWNLOAD_CANCEL = 22, /** * 状æ€--下载失败 */ DOWNLOAD_FAILED = 23, /** * 状æ€--下载æˆåŠŸ */ DOWNLOAD_SUCCESS = 24, /** * 状æ€--å®‰è£…ä¸ */ INSTALLING = 80, /** * 状æ€--安装失败 */ INSTALL_FAILED = 81, /** * 状æ€--安装æˆåŠŸ */ INSTALL_SUCCESS = 82, /** * 状æ€--å‡çº§ä¸ */ UPGRADING = 90, /** * 状æ€--å‡çº§å¤±è´¥ */ UPGRADE_FAILED = 91, /** * 状æ€--å‡çº§æˆåŠŸ */ UPGRADE_SUCCESS = 92, } /** * å‡çº§æŽ¥å£--状æ€ç»“构体 * * @since 2022-06-05 */ export interface OtaStatus { /** * çŠ¶æ€ */ status: number; /** * 进度 */ percent: number; /** * 终æ¢åŽŸå› */ endReason?: string; } /** * å‡çº§é”™è¯¯ç * * @since 2022-06-05 */ export enum ErrorCode { /** * 错误ç --默认失败 */ DEFAULT_ERROR = -1, /** * æœåŒ…结果--网络错误 */ CHECK_NETWORK_ERR = -2, /** * æœåŒ…结果--æœåŒ…ä¸ */ CHECK_SYSTEM_BUSY = -207, /** * 错误ç --鉴æƒå¤±è´¥ */ AUTH_FAIL = '-208', /** * 错误ç --鉴æƒå¤±è´¥æœåŠ¡é”™è¯¯ */ AUTH_SERVER_ERROR = '-209', /** * 错误ç --鉴æƒå¤±è´¥ç³»ç»Ÿé”™è¯¯ */ AUTH_SYSTEM_ERROR = '-210', /** * 错误ç --网络错误 */ NETWORK_ERROR = '-301', /** * 错误ç --空间ä¸è¶³ */ NO_ENOUGH_MEMORY = '-304', /** * 错误ç --检验失败 */ VERIFY_PACKAGE_FAIL = '-305', /** * 错误ç --部分å‡ç´šå¤±æ•— */ UPDATE_PART_FAIL = '-409', /** * 错误ç --电é‡ä¸è¶³ */ NO_ENOUGH_BATTERY = '-830', /** * 错误ç --网络ä¸å…许 */ NETWORK_NOT_ALLOW = '3148800' } /** * é€šç”¨å¸¸é‡ * * @since 2022-06-05 */ export enum UpdateConstant { /** * æœåŒ…é‡è¯•æ—¶é—´ */ CHECKING_RETRY_TIME = 5, /** * æœåŒ…ç‰å¾…é—´éš” */ CHECKING_WAITING_TIME_IN_SECONDS = 3, /** * 安装电é‡é˜ˆå€¼ */ UPGRADE_BATTERY_THRESHOLD = 30 } /** * 更新日志结构体 * * @since 2022-06-05 */ export interface Changelog { /** * 默认è¯è¨€ */ defLanguage?: string; /** * 显示类型 */ displayType?: number; /** * 所有è¯è¨€æ›´æ–°æ—¥å¿— */ language: Map<string, Language>; } /** * 更新日志结构体--è¯è¨€ * * @since 2022-06-05 */ export interface Language { /** * 日志对应è¯è¨€ */ language?: string; /** * 日志特性数组 */ featuresArray: Array<Features>; } /** * 更新日志结构体--ç‰¹æ€§é›†åˆ * * @since 2022-06-05 */ export interface Features { /** * æ ‡é¢˜ */ title: string; /** * æ ‡è¯† */ id: string; /** * 特性类型 */ featureModuleType: string; /** * 特性数组 */ featureList: Array<Feature>; /** * å›¾æ ‡ */ icon: Icon; } /** * 更新日志结构体--特性 * * @since 2022-06-05 */ export interface Feature { /** * åæ ‡é¢˜ */ subTitle: string; /** * 内容数组 */ contents: Array<string>; } /** * 更新日志结构体--å›¾æ ‡ * * @since 2022-06-05 */ export interface Icon { /** * æ ‡è¯† */ id: string; /** * 包å */ pkg: string; /** * æ•°æ®æµå—串 */ res: string; } /** * changelog类型 * * @since 2022-08-26 */ export enum ChangelogType { /** * 文本类型 */ TEXT = -1, /** * 图文类型 */ PICTURE_AND_TEXT = 0, /** * web类型 */ WEB_TYPE = 1, } /** * åŠ¨ä½œå¸¸é‡æžšä¸¾ * * @since 2022-06-05 */ export enum Action { /** * 动作--è·³è½¬ä¸»é¡µé¢æœåŒ… */ NOTIFICATION_LATER = 'com.ohos.updateapp.later', /** * 动作--è·³è½¬ä¸»é¡µé¢æœåŒ… */ NOTIFICATION_CHECK = 'com.ohos.updateapp.check', /** * 动作--下载 */ NOTIFICATION_DOWNLOAD = 'com.ohos.updateapp.download', /** * 动作--跳转新版本页é¢å®‰è£… */ NOTIFICATION_INSTALL = 'com.ohos.updateapp.install', /** * 动作--è·³è½¬æ–°ç‰ˆæœ¬é¡µé¢ */ NOTIFICATION_DETAIL = 'com.ohos.updateapp.detail', /** * 动作--å‡çº§å¤±è´¥è·³è½¬ä¸»é¡µé¢æœåŒ… */ NOTIFICATION_HOT_UPGRADE_FAILED = 'com.ohos.updateapp.hot_upgrade_failed' } /** * æŽ¥å£æ‰§è¡Œç»“æžœ * * @since 2022-07-11 */ export interface UpgradeData<T> { /** * æŽ¥å£æ‰§è¡Œç»“æžœ */ callResult: UpgradeCallResult; /** * å›žè°ƒæ•°æ® */ data?: T; /** * 错误结果 */ error?: BusinessError } /** * æŽ¥å£æ‰§è¡Œé”™è¯¯ç * * @since 2022-07-11 */ export enum UpgradeCallResult { /** * æŽ¥å£æ‰§è¡ŒæˆåŠŸ */ OK = 1, /** * æŽ¥å£æ‰§è¡Œå¤±è´¥ */ ERROR = -1, /** * æŽ¥å£æ‰§è¡Œè¶…æ—¶ */ TIME_OUT = -2 } /** * 倒计时弹窗类型 * * @since 2023-02-08 */ export enum CountDownDialogType { /** * ota20S倒计时 */ OTA = 0, /** * abå‡çº§20S倒计时 */ OTA_AB = 1, } /** * BusinessError * * @since 2023-03-10 */ export interface BusinessError { /** * æ•°æ® */ data?: ErrCode[]; } /** * ErrCode * * @since 2023-03-10 */ export interface ErrCode { /** * 错误ç */ errorCode: ErrorCode; } /** * 包å */ export const PACKAGE_NAME = 'com.ohos.updateapp'; /** * 主abilityå */ export const MAIN_ABILITY_NAME = 'com.ohos.updateapp.MainAbility';