46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.router.d.ts 51.57 KB
一键复制 编辑 原始数据 按行查看 历史
解强龙 提交于 1个月前 . sdk 代码回合
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407
/*
* Copyright (c) 2021-2025 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 ArkUI
*/
import { Callback } from './@ohos.base';
import { AsyncCallback } from './@ohos.base';
/**
* @namespace router
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* @namespace router
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @namespace router
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace router {
/**
* Router Mode
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Router Mode
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Router Mode
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum RouterMode {
/**
* Default route mode.
* The page will be added to the top of the page stack.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Default route mode.
* The page will be added to the top of the page stack.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Default route mode.
* The page will be added to the top of the page stack.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
Standard,
/**
* Single route mode.
* If the target page already has the same url page in the page stack,
* the same url page closest to the top of the stack will be moved to the top of the stack.
* If the target page url does not exist in the page stack, route will use default route mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Single route mode.
* If the target page already has the same url page in the page stack,
* the same url page closest to the top of the stack will be moved to the top of the stack.
* If the target page url does not exist in the page stack, route will use default route mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Single route mode.
* If the target page already has the same url page in the page stack,
* the same url page closest to the top of the stack will be moved to the top of the stack.
* If the target page url does not exist in the page stack, route will use default route mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
Single,
}
/**
* @typedef RouterOptions
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 8
*/
/**
* @typedef RouterOptions
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
*/
/**
* @typedef RouterOptions
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface RouterOptions {
/**
* URI of the destination page, which supports the following formats:
* 1. Absolute path of the page, which is provided by the pages list in the config.json file.
* Example:
* pages/index/index
* pages/detail/detail
* 2. Particular path. If the URI is a slash (/), the home page is displayed.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 8
*/
/**
* URI of the destination page, which supports the following formats:
* 1. Absolute path of the page, which is provided by the pages list in the config.json file.
* Example:
* pages/index/index
* pages/detail/detail
* 2. Particular path. If the URI is a slash (/), the home page is displayed.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
*/
/**
* URI of the destination page, which supports the following formats:
* 1. Absolute path of the page, which is provided by the pages list in the config.json file.
* Example:
* pages/index/index
* pages/detail/detail
* 2. Particular path. If the URI is a slash (/), the home page is displayed.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
url: string;
/**
* Data that needs to be passed to the destination page during navigation.
* After the destination page is displayed, the parameter can be directly used for the page.
* For example, this.data1 (data1 is the key value of the params used for page navigation.)
*
* @type { ?Object }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 8
*/
/**
* Data that needs to be passed to the destination page during navigation.
* After the destination page is displayed, the parameter can be directly used for the page.
* For example, this.data1 (data1 is the key value of the params used for page navigation.)
*
* @type { ?Object }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
*/
/**
* Data that needs to be passed to the destination page during navigation.
* After the destination page is displayed, the parameter can be directly used for the page.
* For example, this.data1 (data1 is the key value of the params used for page navigation.)
*
* @type { ?Object }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
params?: Object;
/**
* Set router page stack can be recovered after application is destroyed. When router page stack is recovered,
* top page will be recovered, other page recovered when it backs. the default value is 'true'.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
recoverable?: boolean;
}
/**
* @typedef RouterState
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* @typedef RouterState
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef RouterState
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
interface RouterState {
/**
* Index of the current page in the stack.
* NOTE: The index starts from 1 from the bottom to the top of the stack.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Index of the current page in the stack.
* NOTE: The index starts from 1 from the bottom to the top of the stack.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Index of the current page in the stack.
* NOTE: The index starts from 1 from the bottom to the top of the stack.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
index: number;
/**
* Name of the current page, that is, the file name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Name of the current page, that is, the file name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Name of the current page, that is, the file name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Path of the current page.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Path of the current page.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Path of the current page.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
path: string;
/**
* Data that passed to the destination page during navigation.
*
* @type { Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
params: Object;
}
/**
* @typedef EnableAlertOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* @typedef EnableAlertOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef EnableAlertOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
interface EnableAlertOptions {
/**
* dialog context.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* dialog context.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* dialog context.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
message: string;
}
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
* @deprecated since 9
* @useinstead ohos.router.router#pushUrl
*/
function push(options: RouterOptions): void;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of pushUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of pushUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of pushUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushUrl
*/
function pushUrl(options: RouterOptions, callback: AsyncCallback<void>): void;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushUrl
*/
function pushUrl(options: RouterOptions): Promise<void>;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of pushUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of pushUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of pushUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushUrl
*/
function pushUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushUrl
*/
function pushUrl(options: RouterOptions, mode: RouterMode): Promise<void>;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 8
* @deprecated since 9
* @useinstead ohos.router.router#replaceUrl
*/
function replace(options: RouterOptions): void;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of replaceUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 9
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of replaceUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceUrl
*/
function replaceUrl(options: RouterOptions, callback: AsyncCallback<void>): void;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 9
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceUrl
*/
function replaceUrl(options: RouterOptions): Promise<void>;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of replaceUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 9
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of replaceUrl.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceUrl
*/
function replaceUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 9
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { RouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
* @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceUrl
*/
function replaceUrl(options: RouterOptions, mode: RouterMode): Promise<void>;
/**
* Returns to the previous page or a specified page.
*
* @param { RouterOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Returns to the previous page or a specified page.
*
* @param { RouterOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Returns to the previous page or a specified page.
*
* @param { RouterOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#back
*/
function back(options?: RouterOptions): void;
/**
* Returns to the specified page.
*
* @param { number } index - index of page.
* @param { Object } [params] - params of page.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#back
*/
function back(index: number, params?: Object): void;
/**
* Clears all historical pages and retains only the current page at the top of the stack.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Clears all historical pages and retains only the current page at the top of the stack.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Clears all historical pages and retains only the current page at the top of the stack.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#clear
*/
function clear(): void;
/**
* Obtains the number of pages in the current stack.
*
* @returns { string } Number of pages in the stack. The maximum value is 32.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Obtains the number of pages in the current stack.
*
* @returns { string } Number of pages in the stack. The maximum value is 32.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Obtains the number of pages in the current stack.
*
* @returns { string } Number of pages in the stack. The maximum value is 32.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#getLength
*/
function getLength(): string;
/**
* Obtains information about the current page state.
*
* @returns { RouterState } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Obtains information about the current page state.
*
* @returns { RouterState } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Obtains information about the current page state.
*
* @returns { RouterState } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#getState
*/
function getState(): RouterState;
/**
* Obtains page information by index.
*
* @param { number } index - Index of page.
* @returns { RouterState | undefined } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#getStateByIndex
*/
function getStateByIndex(index: number): RouterState | undefined;
/**
* Obtains page information by url.
*
* @param { string } url - URL of page.
* @returns { Array<RouterState> } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#getStateByUrl
*/
function getStateByUrl(url: string): Array<RouterState>;
/**
* Pop up dialog to ask whether to back
*
* @param { EnableAlertOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
* @deprecated since 9
* @useinstead ohos.router.router#showAlertBeforeBackPage
*/
function enableAlertBeforeBackPage(options: EnableAlertOptions): void;
/**
* Pop up alert dialog to ask whether to back
*
* @param { EnableAlertOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Pop up alert dialog to ask whether to back
*
* @param { EnableAlertOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Pop up alert dialog to ask whether to back
*
* @param { EnableAlertOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#showAlertBeforeBackPage
*/
function showAlertBeforeBackPage(options: EnableAlertOptions): void;
/**
* Cancel enableAlertBeforeBackPage
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
* @deprecated since 9
* @useinstead ohos.router.router#hideAlertBeforeBackPage
*/
function disableAlertBeforeBackPage(): void;
/**
* Hide alert before back page
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Hide alert before back page
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Hide alert before back page
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#hideAlertBeforeBackPage
*/
function hideAlertBeforeBackPage(): void;
/**
* Obtains information about the current page params.
*
* @returns { Object } Page params.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Obtains information about the current page params.
*
* @returns { Object } Page params.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Obtains information about the current page params.
*
* @returns { Object } Page params.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#getParams
*/
function getParams(): Object;
/**
* @typedef NamedRouterOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* @typedef NamedRouterOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
interface NamedRouterOptions {
/**
* Name of the destination named route.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Name of the destination named route.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Data that needs to be passed to the destination page during navigation.
*
* @type { ?Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Data that needs to be passed to the destination page during navigation.
*
* @type { ?Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
params?: Object;
/**
* Set router page stack can be recovered after application is destroyed. When router page stack is recovered,
* top page will be recovered, other page recovered when it backs. the default value is 'true'.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since arkts {'1.1':'14','1.2':'20'}
* @arkts 1.1&1.2
*/
recoverable?: boolean;
}
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of pushNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of pushNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushNamedRoute
*/
function pushNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void>): void;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushNamedRoute
*/
function pushNamedRoute(options: NamedRouterOptions): Promise<void>;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of pushNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of pushNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushNamedRoute
*/
function pushNamedRoute(options: NamedRouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void;
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Navigates to a specified page in the application based on the page URL and parameters.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#pushNamedRoute
*/
function pushNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<void>;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of replaceNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @param { AsyncCallback<void> } callback - the callback of replaceNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceNamedRoute
*/
function replaceNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void>): void;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceNamedRoute
*/
function replaceNamedRoute(options: NamedRouterOptions): Promise<void>;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of replaceNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @param { AsyncCallback<void> } callback - the callback of replaceNamedRoute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceNamedRoute
*/
function replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void;
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Replaces the current page with another one in the application. The current page is destroyed after replacement.
*
* @param { NamedRouterOptions } options - Options.
* @param { RouterMode } mode - RouterMode.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system.
* @throws { BusinessError } 100004 - Named route error. The named route does not exist.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 18
* @useinstead ohos.arkui.UIContext.Router#replaceNamedRoute
*/
function replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<void>;
}
export default router;
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

搜索帮助